{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.58.7", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@jsx", "syntaxKind": "block" }, { "tagName": "@jsxRuntime", "syntaxKind": "block" }, { "tagName": "@jsxFrag", "syntaxKind": "block" }, { "tagName": "@jsxImportSource", "syntaxKind": "block" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" }, { "tagName": "@default", "syntaxKind": "block" }, { "tagName": "@official", "syntaxKind": "block" }, { "tagName": "@remark", "syntaxKind": "block" }, { "tagName": "@since", "syntaxKind": "block" }, { "tagName": "@todo", "syntaxKind": "block" }, { "tagName": "@tutorial", "syntaxKind": "block" }, { "tagName": "@unofficial", "syntaxKind": "block" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true, "@default": true, "@official": true, "@remark": true, "@since": true, "@todo": true, "@tutorial": true, "@unofficial": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "obsidian-typings!", "docComment": "", "name": "obsidian-typings", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "obsidian-typings!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Interface", "canonicalReference": "obsidian-typings!AbsFunction:interface", "docComment": "/**\n * Function `Abs`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AbsFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/AbsFunction.d.ts", "releaseTag": "Public", "name": "AbsFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AbstractFileTreeItem:interface", "docComment": "/**\n * Base interface for file and folder tree items in the file explorer.\n *\n * @typeParam T - The type of the abstract file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AbstractFileTreeItem extends " }, { "kind": "Reference", "text": "TreeItem", "canonicalReference": "obsidian-typings!TreeItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/AbstractFileTreeItem.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "AbstractFileTreeItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#file:member", "docComment": "/**\n * Associated file with this item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#getTitle:member(1)", "docComment": "/**\n * Get the display title for this tree item.\n *\n * @returns The display title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTitle(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTitle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#info:member", "docComment": "/**\n * {@link Tree} node metadata and layout information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "info: " }, { "kind": "Reference", "text": "TreeNodeInfo", "canonicalReference": "obsidian-typings!TreeNodeInfo:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "info", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#isFullTimeShown:member(1)", "docComment": "/**\n * Whether the full timestamp is shown for this item.\n *\n * @returns Whether the full timestamp is shown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isFullTimeShown(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isFullTimeShown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#onRender:member(1)", "docComment": "/**\n * Called when this item is rendered to the DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRender(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onRender" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#parent:member", "docComment": "/**\n * Parent tree item (folder or tree root).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent: " }, { "kind": "Reference", "text": "FileTreeItemParent", "canonicalReference": "obsidian-typings!FileTreeItemParent:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#rendered:member", "docComment": "/**\n * Whether this item has been rendered to the DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rendered: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rendered", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#startRename:member(1)", "docComment": "/**\n * Begin inline renaming of this tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startRename(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "startRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#stopRename:member(1)", "docComment": "/**\n * Cancel inline renaming of this tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopRename(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#updateTitle:member(1)", "docComment": "/**\n * Refresh the displayed title of this tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateTitle(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateTitle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractFileTreeItem#view:member", "docComment": "/**\n * Reference to the file explorer view containing this item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "view: " }, { "kind": "Reference", "text": "FileExplorerView", "canonicalReference": "obsidian-typings!FileExplorerView:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AbstractSearchComponent:interface", "docComment": "/**\n * Base interface for search components providing find-and-replace UI.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AbstractSearchComponent " } ], "fileUrlPath": "src/obsidian/internals/components/AbstractSearchComponent.d.ts", "releaseTag": "Public", "name": "AbstractSearchComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#containerEl:member", "docComment": "/**\n * The container element in which the search component exists (i.e. {@link obsidian#Editor}).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#getQuery:member(1)", "docComment": "/**\n * Returns the current search query.\n *\n * @returns The current search query string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getQuery(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getQuery" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#goToNextInput:member(1)", "docComment": "/**\n * Switch to the next inputElement.\n *\n * @param event - The keyboard event that triggered the input switch.\n *\n * @returns The result of switching to the next input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goToNextInput(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "goToNextInput" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#onEnter:member(1)", "docComment": "/**\n * Invokes findNextOrReplace.\n *\n * @param event - The keyboard event that triggered the action.\n *\n * @returns The result of the enter action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEnter(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onEnter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#onShiftEnter:member(1)", "docComment": "/**\n * Invokes findPrevious.\n *\n * @param event - The keyboard event that triggered the action.\n *\n * @returns The result of the shift-enter action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onShiftEnter(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onShiftEnter" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#replaceInputEl:member", "docComment": "/**\n * Container for the replacement input field.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceInputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "replaceInputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#scope:member", "docComment": "/**\n * Keyscope for search component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scope: " }, { "kind": "Reference", "text": "Scope", "canonicalReference": "obsidian!Scope:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#searchButtonContainerEl:member", "docComment": "/**\n * Container for all the action buttons.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchButtonContainerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchButtonContainerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#searchContainerEl:member", "docComment": "/**\n * Container for the search component itself.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchContainerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchContainerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AbstractSearchComponent#searchInputEl:member", "docComment": "/**\n * Container for the search input field.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchInputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchInputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Account:interface", "docComment": "/**\n * Represents the user's Obsidian account information and license details.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Account " } ], "fileUrlPath": "src/obsidian/internals/Account.d.ts", "releaseTag": "Public", "name": "Account", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#company:member", "docComment": "/**\n * The company associated with the activated commercial license.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "company: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "company", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#email:member", "docComment": "/**\n * The email address associated with the account.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "email: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "email", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#expiry:member", "docComment": "/**\n * Unix timestamp of the license expiry date.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "expiry: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "expiry", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#key:member", "docComment": "/**\n * License key string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "key: " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#keyValidation:member", "docComment": "/**\n * Validation status or hash for the license key.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyValidation: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyValidation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#license:member", "docComment": "/**\n * The license available to the account.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "license: " }, { "kind": "Content", "text": "'' | 'insider'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "license", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#name:member", "docComment": "/**\n * Profile name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#seats:member", "docComment": "/**\n * Number of seats available on the commercial license.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "seats: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "seats", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Account#token:member", "docComment": "/**\n * Authentication token for the account.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "token: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "token", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AddOverlayOptions:interface", "docComment": "/**\n * Options for adding a search overlay to the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AddOverlayOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/AddOverlayOptions.d.ts", "releaseTag": "Public", "name": "AddOverlayOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AddOverlayOptions#query:member", "docComment": "/**\n * Regular expression pattern to highlight in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AddResourceOptions:interface", "docComment": "/**\n * Options for adding a single resource entry.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AddResourceOptions " } ], "fileUrlPath": "src/i18next/internals/AddResourceOptions.d.ts", "releaseTag": "Public", "name": "AddResourceOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AddResourceOptions#keySeparator:member", "docComment": "/**\n * Custom key separator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keySeparator?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "keySeparator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AddResourceOptions#silent:member", "docComment": "/**\n * Whether to suppress events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "silent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "silent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for aliases.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AliasesPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/AliasesPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "AliasesPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent#containerEl:member", "docComment": "/**\n * The container element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent#ctx:member", "docComment": "/**\n * The render context for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ctx: " }, { "kind": "Reference", "text": "PropertyRenderContext", "canonicalReference": "obsidian-typings!PropertyRenderContext:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ctx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent#hoverPopover:member", "docComment": "/**\n * The hover popover for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverPopover: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverPopover", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent#multiselect:member", "docComment": "/**\n * The multiselect component for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "multiselect: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "multiselect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'aliases'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AllPropertiesView:interface", "docComment": "/**\n * {@link obsidian#View} that displays all properties (frontmatter keys) across the vault.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AllPropertiesView extends " }, { "kind": "Reference", "text": "ItemView", "canonicalReference": "obsidian!ItemView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/properties/AllPropertiesView.d.ts", "releaseTag": "Public", "name": "AllPropertiesView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#acceptRename:member(1)", "docComment": "/**\n * Try to rename the file.\n *\n * @returns A promise that resolves when the rename is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "acceptRename(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "acceptRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#cancelRename:member(1)", "docComment": "/**\n * Cancels the rename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancelRename(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cancelRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#exitRename:member(1)", "docComment": "/**\n * Quits the rename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exitRename(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "exitRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The all properties view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.AllProperties", "canonicalReference": "obsidian-typings!~__type#AllProperties:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#isItem:member(1)", "docComment": "/**\n * Check whether the given object is a property item.\n *\n * @param e - The object to check.\n *\n * @returns Whether the object is a property item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isItem(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#onKeyEnterInFocus:member(1)", "docComment": "/**\n * Select the item in focus if pressed 'Enter'.\n *\n * @param event - The event triggered this function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyEnterInFocus(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyEnterInFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#onKeyEnterInRename:member(1)", "docComment": "/**\n * Called when 'Enter' is pressed while rename. Accepts the rename.\n *\n * @param event - The event triggered this function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyEnterInRename(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyEnterInRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#onToggleShowSearch:member(1)", "docComment": "/**\n * Toggles the visibility of the search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onToggleShowSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onToggleShowSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#setShowSearch:member(1)", "docComment": "/**\n * Set the visibility of the search filter.\n *\n * @param e - Whether to show the search filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setShowSearch(e: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setShowSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#setSortOrder:member(1)", "docComment": "/**\n * Updates the sort order and sort by it.\n *\n * @param order - The sort order.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSortOrder(order: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "order", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSortOrder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#showSearch:member(1)", "docComment": "/**\n * Shows the search and focus is.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#startRename:member(1)", "docComment": "/**\n * Begin inline renaming of a property.\n *\n * @param e - The property item to rename.\n *\n * @returns The result of the rename operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startRename(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "startRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#update:member(1)", "docComment": "/**\n * Refresh the properties list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AllPropertiesView#updateSearch:member(1)", "docComment": "/**\n * Updates the search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateSearch" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!app_2:var", "docComment": "/**\n * Electron app instance for managing the application lifecycle.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "ElectronApp", "canonicalReference": "obsidian-typings!ElectronApp:interface" } ], "fileUrlPath": "src/electron/internals/vars/app.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "app_2", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Class", "canonicalReference": "obsidian-typings!Application:class", "docComment": "/**\n * PixiJS application.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Application " } ], "fileUrlPath": "src/pixi.js/internals/Application.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "VIEW", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "isAbstract": false, "name": "Application", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!Application:constructor(1)", "docComment": "/**\n * Creates a new application.\n *\n * @param options - Application options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IApplicationOptions", "canonicalReference": "obsidian-typings!IApplicationOptions:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!Application#destroy:member(1)", "docComment": "/**\n * Destroys the application.\n *\n * @param removeView - Whether to remove the view from the DOM.\n *\n * @param stageOptions - Options for destroying the stage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(removeView?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", stageOptions?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "IDestroyOptions", "canonicalReference": "obsidian-typings!IDestroyOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "removeView", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "stageOptions", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Application#render:member(1)", "docComment": "/**\n * Renders the application.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "render" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Application#renderer:member", "docComment": "/**\n * Renderer instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderer: " }, { "kind": "Reference", "text": "IRenderer", "canonicalReference": "obsidian-typings!IRenderer:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Application#screen:member", "docComment": "/**\n * Screen rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get screen(): " }, { "kind": "Reference", "text": "PixiRectangle", "canonicalReference": "obsidian-typings!PixiRectangle:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "screen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Application#stage:member", "docComment": "/**\n * Root container of the scene graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stage: " }, { "kind": "Reference", "text": "Container", "canonicalReference": "obsidian-typings!Container:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Application#view:member", "docComment": "/**\n * Canvas view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get view(): " }, { "kind": "Content", "text": "VIEW" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AppMenuBarManager:interface", "docComment": "/**\n * Manager for the application menu bar (native desktop menu).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AppMenuBarManager " } ], "fileUrlPath": "src/obsidian/internals/AppMenuBarManager.d.ts", "releaseTag": "Public", "name": "AppMenuBarManager", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#_onFileOpen:member(1)", "docComment": "/**\n * Internal handler for file open events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_onFileOpen(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "_onFileOpen" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#applyHotkeys:member(1)", "docComment": "/**\n * Apply hotkey accelerators to menu items.\n *\n * @returns The result of applying hotkeys. To get the constructor instance, use {@link getAppMenuBarManagerConstructor} from `obsidian-typings/implementations`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applyHotkeys(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "applyHotkeys" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#buildMenu:member(1)", "docComment": "/**\n * Build the native menu bar structure.\n *\n * @returns The built menu structure.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buildMenu(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "buildMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getAppMenuBarManagerConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#constructor:member", "docComment": "/**\n * Constructor reference for the menu bar manager.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor: " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AppMenuBarManager", "canonicalReference": "obsidian-typings!AppMenuBarManager:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "constructor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#getAcceleratorFromHotkey:member(1)", "docComment": "/**\n * Convert a hotkey binding to a native accelerator string.\n *\n * @returns The native accelerator string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAcceleratorFromHotkey(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getAcceleratorFromHotkey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#hideUnregisteredCommands:member(1)", "docComment": "/**\n * Hide menu items for commands that are not registered.\n *\n * @returns The result of hiding unregistered commands.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hideUnregisteredCommands(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "hideUnregisteredCommands" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#onFileOpen:member", "docComment": "/**\n * Debounced handler for file open events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileOpen: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onFileOpen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#onWindowFrameChange:member", "docComment": "/**\n * Debounced handler for window frame changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onWindowFrameChange: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onWindowFrameChange", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#render:member(1)", "docComment": "/**\n * Render the menu bar.\n *\n * @returns The result of the render operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#requestRender:member", "docComment": "/**\n * Debounced function to re-render the menu bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestRender: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestRender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#updateShareMenuItem:member(1)", "docComment": "/**\n * Update the share menu item state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateShareMenuItem(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateShareMenuItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#updateViewState:member(1)", "docComment": "/**\n * Update the menu bar based on the current view state.\n *\n * @returns The result of updating the view state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateViewState(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateViewState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppMenuBarManager#updateWorkspace:member(1)", "docComment": "/**\n * Update the menu bar based on workspace changes.\n *\n * @returns The result of updating the workspace.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateWorkspace(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateWorkspace" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AppSetting:interface", "docComment": "/**\n * The settings modal for the application, managing core and plugin setting tabs.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AppSetting extends " }, { "kind": "Reference", "text": "Modal", "canonicalReference": "obsidian!Modal:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/AppSetting.d.ts", "releaseTag": "Public", "name": "AppSetting", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#activeTab:member", "docComment": "/**\n * Current active tab of the settings modal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "activeTab: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "activeTab", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#addSettingTab:member(1)", "docComment": "/**\n * Add a new plugin tab to the settings modal.\n *\n * @param tab - Tab to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSettingTab(tab: " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tab", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addSettingTab" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#closeActiveTab:member(1)", "docComment": "/**\n * Closes the currently active tab.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeActiveTab(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "closeActiveTab" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#communityPluginTabContainer:member", "docComment": "/**\n * Container element containing the community plugins\n */\n", "excerptTokens": [ { "kind": "Content", "text": "communityPluginTabContainer: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "communityPluginTabContainer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#communityPluginTabHeaderGroup:member", "docComment": "/**\n * Container element containing the community plugins header.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "communityPluginTabHeaderGroup: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "communityPluginTabHeaderGroup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getAppSettingConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#corePluginTabContainer:member", "docComment": "/**\n * Container element containing the core plugins.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "corePluginTabContainer: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "corePluginTabContainer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#corePluginTabHeaderGroup:member", "docComment": "/**\n * Container element containing the core plugins header.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "corePluginTabHeaderGroup: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "corePluginTabHeaderGroup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#feedbackBanner:member", "docComment": "/**\n * Feedback banner element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "feedbackBanner: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "feedbackBanner", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#isPluginSettingTab:member(1)", "docComment": "/**\n * Check whether tab is a plugin tab.\n *\n * @param tab - Tab to check.\n *\n * @returns Whether the tab is a plugin setting tab.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPluginSettingTab(tab: " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tab", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isPluginSettingTab" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#lastTabId:member", "docComment": "/**\n * Previously opened tab ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastTabId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastTabId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#openTab:member(1)", "docComment": "/**\n * Open a specific tab by tab reference.\n *\n * @param tab - Tab to open.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openTab(tab: " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tab", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "openTab" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#openTabById:member(1)", "docComment": "/**\n * Open the hotkeys setting tab by ID.\n *\n * @param id - The hotkeys tab ID.\n *\n * @returns The hotkeys setting tab.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openTabById(id: " }, { "kind": "Content", "text": "'hotkeys'" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HotkeysSettingTab", "canonicalReference": "obsidian-typings!HotkeysSettingTab:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "openTabById" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#openTabById:member(2)", "docComment": "/**\n * Open a specific tab by ID.\n *\n * @param id - ID of the tab to open.\n *\n * @returns The opened setting tab.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openTabById(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "openTabById" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#pluginTabs:member", "docComment": "/**\n * List of all plugin tabs (core and community, ordered by precedence).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pluginTabs: " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pluginTabs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#removeSettingTab:member(1)", "docComment": "/**\n * Remove a plugin tab from the settings modal.\n *\n * @param tab - Tab to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeSettingTab(tab: " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tab", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeSettingTab" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#settingTabs:member", "docComment": "/**\n * List of all core settings tabs (editor, files & links, ...).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "settingTabs: " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "settingTabs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#tabContainer:member", "docComment": "/**\n * Container element containing the core settings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabContainer: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tabContainer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#tabContentContainer:member", "docComment": "/**\n * Container for currently active settings tab.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabContentContainer: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tabContentContainer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppSetting#tabHeadersEl:member", "docComment": "/**\n * Container for all settings tabs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabHeadersEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tabHeadersEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#updateModalTitle:member(1)", "docComment": "/**\n * Update the title of the modal.\n *\n * @param tab - Tab to update the title to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateModalTitle(tab: " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tab", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateModalTitle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AppSetting#updatePluginSection:member(1)", "docComment": "/**\n * Update a tab section.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updatePluginSection(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updatePluginSection" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AppVaultConfig:interface", "docComment": "/**\n * Vault-level configuration settings stored in the `.obsidian` config folder.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AppVaultConfig " } ], "fileUrlPath": "src/obsidian/internals/app-vault-config/AppVaultConfig.d.ts", "releaseTag": "Public", "name": "AppVaultConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#accentColor:member", "docComment": "/**\n * Appearance > Accent color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accentColor: " }, { "kind": "Content", "text": "'' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "accentColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#alwaysUpdateLinks:member", "docComment": "/**\n * Files & Links > Automatically update internal links.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alwaysUpdateLinks?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "alwaysUpdateLinks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#attachmentFolderPath:member", "docComment": "/**\n * Files & Links > Attachment folder path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attachmentFolderPath?: " }, { "kind": "Content", "text": "'/' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "attachmentFolderPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#autoConvertHtml:member", "docComment": "/**\n * Editor > Auto convert HTML.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoConvertHtml?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autoConvertHtml", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#autoPairBrackets:member", "docComment": "/**\n * Editor > Auto pair brackets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoPairBrackets?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autoPairBrackets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#autoPairMarkdown:member", "docComment": "/**\n * Editor > Auto pair Markdown syntax.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoPairMarkdown?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autoPairMarkdown", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#baseFontSize:member", "docComment": "/**\n * Appearance > Font size.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "baseFontSize?: " }, { "kind": "Content", "text": "16 | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "baseFontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#baseFontSizeAction:member", "docComment": "/**\n * Appearance > Quick font size adjustment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "baseFontSizeAction?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "baseFontSizeAction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#communityPluginSortOrder:member", "docComment": "/**\n * Community Plugins > Browse > Sort order.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "communityPluginSortOrder: " }, { "kind": "Content", "text": "'alphabetical' | 'download' | 'release' | 'update'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "communityPluginSortOrder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#communityThemeSortOrder:member", "docComment": "/**\n * Themes > Browse > Sort order.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "communityThemeSortOrder: " }, { "kind": "Content", "text": "'alphabetical' | 'download' | 'release' | 'update'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "communityThemeSortOrder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#cssTheme:member", "docComment": "/**\n * Appearance > Theme.\n *\n * @remark\n *\n * is the default Obsidian theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cssTheme?: " }, { "kind": "Content", "text": "'' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cssTheme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#defaultViewMode:member", "docComment": "/**\n * Editor > Default view for new tabs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultViewMode?: " }, { "kind": "Content", "text": "'preview' | 'source'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultViewMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#emacsyKeys:member", "docComment": "/**\n * Whether Emacs-style keybindings are enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "emacsyKeys?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "emacsyKeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#enabledCssSnippets:member", "docComment": "/**\n * Appearance > CSS snippets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabledCssSnippets?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enabledCssSnippets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#fileSortOrder:member", "docComment": "/**\n * Sort order for files in the file explorer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fileSortOrder?: " }, { "kind": "Content", "text": "'alphabetical'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fileSortOrder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#focusNewTab:member", "docComment": "/**\n * Editor > Always focus new tabs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusNewTab?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "focusNewTab", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#foldHeading:member", "docComment": "/**\n * Editor > Fold heading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "foldHeading?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "foldHeading", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#foldIndent:member", "docComment": "/**\n * Editor > Fold indent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "foldIndent?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "foldIndent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#hotkeys:member", "docComment": "/**\n * Hotkeys.\n *\n * @deprecated\n *\n * Likely not used anymore.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hotkeys?: " }, { "kind": "Reference", "text": "AppVaultConfigHotkeysRecord", "canonicalReference": "obsidian-typings!AppVaultConfigHotkeysRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hotkeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#interfaceFontFamily:member", "docComment": "/**\n * Appearance > Interface font.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interfaceFontFamily?: " }, { "kind": "Content", "text": "'' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "interfaceFontFamily", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#legacyEditor:member", "docComment": "/**\n * Editor > Use legacy editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "legacyEditor?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "legacyEditor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#livePreview:member", "docComment": "/**\n * Whether live preview mode is enabled in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "livePreview?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "livePreview", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#mobilePullAction:member", "docComment": "/**\n * Mobile > Configure mobile Quick Action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mobilePullAction?: " }, { "kind": "Content", "text": "'command-palette:open' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mobilePullAction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#mobileQuickRibbonItem:member", "docComment": "/**\n * Command ID for the mobile quick ribbon action item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mobileQuickRibbonItem?: " }, { "kind": "Content", "text": "'' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mobileQuickRibbonItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#mobileToolbarCommands:member", "docComment": "/**\n * Mobile > Manage toolbar options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mobileToolbarCommands?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mobileToolbarCommands", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#monospaceFontFamily:member", "docComment": "/**\n * Appearance > Monospace font.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "monospaceFontFamily?: " }, { "kind": "Content", "text": "'' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "monospaceFontFamily", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#nativeMenus:member", "docComment": "/**\n * Appearance > Native menus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nativeMenus?: " }, { "kind": "Content", "text": "boolean | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nativeMenus", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#newFileFolderPath:member", "docComment": "/**\n * Files & Links > Default location for new notes | 'folder' > Folder to create new notes in.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newFileFolderPath?: " }, { "kind": "Content", "text": "'/' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "newFileFolderPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#newFileLocation:member", "docComment": "/**\n * Files & Links > Default location for new notes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newFileLocation?: " }, { "kind": "Content", "text": "'current' | 'folder' | 'root'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "newFileLocation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#newLinkFormat:member", "docComment": "/**\n * Files & Links > New link format.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newLinkFormat?: " }, { "kind": "Content", "text": "'absolute' | 'relative' | 'shortest'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "newLinkFormat", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#pdfExportSettings:member", "docComment": "/**\n * Saved on executing 'Export to PDF' command.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pdfExportSettings?: " }, { "kind": "Reference", "text": "PdfExportSettings", "canonicalReference": "obsidian-typings!PdfExportSettings:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pdfExportSettings", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#promptDelete:member", "docComment": "/**\n * Files & Links > Confirm line deletion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promptDelete?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "promptDelete", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#propertiesInDocument:member", "docComment": "/**\n * Editor > Properties in document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "propertiesInDocument?: " }, { "kind": "Content", "text": "'hidden' | 'source' | 'visible'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "propertiesInDocument", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#readableLineLength:member", "docComment": "/**\n * Editor > Readable line length.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readableLineLength?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "readableLineLength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#rightToLeft:member", "docComment": "/**\n * Editor > Right-to-left (RTL).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rightToLeft?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rightToLeft", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#showIndentGuide:member", "docComment": "/**\n * Editor > Show indentation guides.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showIndentGuide?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showIndentGuide", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#showInlineTitle:member", "docComment": "/**\n * Editor > Show inline title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showInlineTitle?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showInlineTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#showLineNumber:member", "docComment": "/**\n * Editor > Show line numbers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showLineNumber?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showLineNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#showRibbon:member", "docComment": "/**\n * Appearance > Show ribbon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showRibbon?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showRibbon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#showUnsupportedFiles:member", "docComment": "/**\n * Files & Links > Detect all file extensions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showUnsupportedFiles?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showUnsupportedFiles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#showViewHeader:member", "docComment": "/**\n * Appearance > Show tab title bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showViewHeader?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showViewHeader", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#smartIndentList:member", "docComment": "/**\n * Editor > Smart indent lists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "smartIndentList?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "smartIndentList", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#spellcheck:member", "docComment": "/**\n * Editor > Spellcheck.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "spellcheck?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "spellcheck", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#spellcheckLanguages:member", "docComment": "/**\n * Editor > Spellcheck languages.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "spellcheckLanguages?: " }, { "kind": "Content", "text": "null | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "spellcheckLanguages", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#strictLineBreaks:member", "docComment": "/**\n * Editor > Strict line breaks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "strictLineBreaks?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "strictLineBreaks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#tabSize:member", "docComment": "/**\n * Editor > Tab indent size.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabSize?: " }, { "kind": "Content", "text": "4 | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tabSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#textFontFamily:member", "docComment": "/**\n * Appearance > Text font.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textFontFamily?: " }, { "kind": "Content", "text": "'' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "textFontFamily", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#theme:member", "docComment": "/**\n * Appearance > Base color scheme.\n *\n * @remark\n *\n * Not be confused with cssTheme, this setting is for the light/dark mode.\n *\n * @remark\n *\n * moonstone is light theme, 'obsidian' is dark theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "theme?: " }, { "kind": "Content", "text": "'moonstone' | 'obsidian'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "theme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#translucency:member", "docComment": "/**\n * Appearance > Translucent window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "translucency?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "translucency", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#trashOption:member", "docComment": "/**\n * Files & Links > Deleted files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trashOption?: " }, { "kind": "Content", "text": "'local' | 'none' | 'system'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "trashOption", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#types:member", "docComment": "/**\n * Left-over storage for old properties types.\n *\n * @deprecated\n *\n * Probably left-over code from old properties type storage\n */\n", "excerptTokens": [ { "kind": "Content", "text": "types: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "types", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#useMarkdownLinks:member", "docComment": "/**\n * Files & Links > Use [[Wikilinks]].\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useMarkdownLinks?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "useMarkdownLinks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#userIgnoreFilters:member", "docComment": "/**\n * Files & Links > Excluded files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userIgnoreFilters?: " }, { "kind": "Content", "text": "null | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "userIgnoreFilters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#useTab:member", "docComment": "/**\n * Editor > Indent using tabs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useTab?: " }, { "kind": "Content", "text": "boolean | true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "useTab", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AppVaultConfig#vimMode:member", "docComment": "/**\n * Editor > Vim key bindings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vimMode?: " }, { "kind": "Content", "text": "boolean | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "vimMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AppVaultConfigHotkeysRecord:interface", "docComment": "/**\n * Record mapping hotkey identifiers to their string representations in vault config.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AppVaultConfigHotkeysRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/app-vault-config/AppVaultConfigHotkeysRecord.d.ts", "releaseTag": "Public", "name": "AppVaultConfigHotkeysRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AudioRecorderPlugin:interface", "docComment": "/**\n * Internal plugin registration for the audio recorder feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AudioRecorderPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AudioRecorderPluginInstance", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/audio-recorder/AudioRecorderPlugin.d.ts", "releaseTag": "Public", "name": "AudioRecorderPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance:interface", "docComment": "/**\n * Plugin instance for the audio recorder, providing methods to record and save audio clips.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AudioRecorderPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AudioRecorderPlugin", "canonicalReference": "obsidian-typings!AudioRecorderPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/audio-recorder/AudioRecorderPluginInstance.d.ts", "releaseTag": "Public", "name": "AudioRecorderPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#checkPermission:member(1)", "docComment": "/**\n * Check if the user has granted microphone permission.\n *\n * @returns Whether microphone permission is granted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkPermission(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "checkPermission" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#extension:member", "docComment": "/**\n * File extension used for saved audio recordings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extension: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "extension", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#onRecordAudio:member(1)", "docComment": "/**\n * Initiate the audio recording flow.\n *\n * @returns A promise that resolves when the recording flow completes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRecordAudio(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onRecordAudio" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#onStartRecording:member(1)", "docComment": "/**\n * Start a new audio recording session.\n *\n * @returns A promise that resolves when recording has started.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onStartRecording(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onStartRecording" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#onStopRecording:member(1)", "docComment": "/**\n * Stop the current audio recording session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onStopRecording(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onStopRecording" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#plugin:member", "docComment": "/**\n * Reference to the audio recorder plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "AudioRecorderPlugin", "canonicalReference": "obsidian-typings!AudioRecorderPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#recorder:member", "docComment": "/**\n * Active MediaRecorder instance, or `null` when not recording.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "recorder: " }, { "kind": "Reference", "text": "MediaRecorder", "canonicalReference": "!MediaRecorder:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "recorder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#recording:member", "docComment": "/**\n * Whether audio is currently being recorded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "recording: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "recording", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#saveRecording:member(1)", "docComment": "/**\n * Save the recorded audio buffer to a file in the vault.\n *\n * @param audioBuffer - The recorded audio data.\n *\n * @returns A promise that resolves when the recording is saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveRecording(audioBuffer: " }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "audioBuffer", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "saveRecording" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#showRecordingMessage:member(1)", "docComment": "/**\n * Display a recording status message or error to the user.\n *\n * @param message - The message to display.\n *\n * @param isError - Whether the message is an error.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showRecordingMessage(message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", isError: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "isError", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showRecordingMessage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance#startRecording:member(1)", "docComment": "/**\n * Begin recording audio from the given media stream.\n *\n * @param stream - The media stream to record from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startRecording(stream: " }, { "kind": "Reference", "text": "MediaStream", "canonicalReference": "!MediaStream:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "stream", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "startRecording" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!AudioView:interface", "docComment": "/**\n * View for rendering and playing audio files.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AudioView extends " }, { "kind": "Reference", "text": "EditableFileView", "canonicalReference": "obsidian!EditableFileView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/AudioView.d.ts", "releaseTag": "Public", "name": "AudioView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!AudioView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The view type identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BacklinkComponent:interface", "docComment": "/**\n * Main UI component that renders backlinks and unlinked mentions for a file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BacklinkComponent extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/backlink/BacklinkComponent.d.ts", "releaseTag": "Public", "name": "BacklinkComponent", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#addLinkFunction:member(1)", "docComment": "/**\n * Add a link from an unlinked mention to the target file.\n *\n * @returns The result of adding the link.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addLinkFunction(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "addLinkFunction" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#backlinkCollapsed:member", "docComment": "/**\n * Whether the backlink section is collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlinkCollapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backlinkCollapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#backlinkCountEl:member", "docComment": "/**\n * Element displaying the count of backlinks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlinkCountEl: " }, { "kind": "Reference", "text": "HTMLSpanElement", "canonicalReference": "!HTMLSpanElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backlinkCountEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#backlinkDom:member", "docComment": "/**\n * DOM tree rendering backlink search results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlinkDom: " }, { "kind": "Reference", "text": "ResultDom", "canonicalReference": "obsidian-typings!ResultDom:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backlinkDom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#backlinkFile:member", "docComment": "/**\n * File for which backlinks are currently displayed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlinkFile: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backlinkFile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#backlinkHeaderEl:member", "docComment": "/**\n * Header element for the backlinks section.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlinkHeaderEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backlinkHeaderEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#backlinkQueue:member", "docComment": "/**\n * Queue of files to process for backlink computation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlinkQueue: " }, { "kind": "Reference", "text": "ItemQueue", "canonicalReference": "obsidian-typings!ItemQueue:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "> | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backlinkQueue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#collapseAll:member", "docComment": "/**\n * Whether all result items are collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapseAll: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapseAll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#collapseAllButtonEl:member", "docComment": "/**\n * Button element to toggle collapse all results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapseAllButtonEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapseAllButtonEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#extraContext:member", "docComment": "/**\n * Whether extra context lines are shown around matches.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extraContext: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "extraContext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#extraContextButtonEl:member", "docComment": "/**\n * Button element to toggle extra context display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extraContextButtonEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "extraContextButtonEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#file:member", "docComment": "/**\n * The file whose backlinks are being shown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#getState:member(1)", "docComment": "/**\n * Get the current state of the backlink component.\n *\n * @returns The current state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getState(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getState" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#headerDom:member", "docComment": "/**\n * Header DOM for navigation buttons and sort controls.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headerDom: " }, { "kind": "Reference", "text": "HeaderDom", "canonicalReference": "obsidian-typings!HeaderDom:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "headerDom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#isShowingSearch:member", "docComment": "/**\n * Whether the search filter is currently visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isShowingSearch: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isShowingSearch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onFileChanged:member(1)", "docComment": "/**\n * Handle a file content change event.\n *\n * @returns The handler result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileChanged(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileChanged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onFileDeleted:member(1)", "docComment": "/**\n * Handle a file deletion event.\n *\n * @returns The handler result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileDeleted(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileDeleted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onFileRename:member(1)", "docComment": "/**\n * Handle a file rename event.\n *\n * @returns The handler result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileRename(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onload:member(1)", "docComment": "/**\n * Lifecycle hook called when the component is loaded.\n *\n * @returns The load result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onload(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onMetadataChanged:member(1)", "docComment": "/**\n * Handle a metadata cache change event.\n *\n * @returns The handler result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMetadataChanged(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onMetadataChanged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onResize:member(1)", "docComment": "/**\n * Handle the component being resized.\n *\n * @returns The handler result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onToggleCollapseClick:member(1)", "docComment": "/**\n * Handle the collapse all toggle button click.\n *\n * @returns The handler result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onToggleCollapseClick(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onToggleCollapseClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onToggleMoreContextClick:member(1)", "docComment": "/**\n * Handle the extra context toggle button click.\n *\n * @returns The handler result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onToggleMoreContextClick(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onToggleMoreContextClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#onToggleShowSearch:member(1)", "docComment": "/**\n * Handle the show search toggle button click.\n *\n * @returns The handler result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onToggleShowSearch(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onToggleShowSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#passSearchFilter:member(1)", "docComment": "/**\n * Check if a result passes the current search filter.\n *\n * @returns Whether the result passes the filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "passSearchFilter(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "passSearchFilter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#recomputeBacklink:member(1)", "docComment": "/**\n * Recompute backlinks for the given file.\n *\n * @param backlinkFile - The file to recompute backlinks for, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "recomputeBacklink(backlinkFile: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "backlinkFile", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "recomputeBacklink" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#recomputeUnlinked:member(1)", "docComment": "/**\n * Recompute unlinked mentions for the current file.\n *\n * @returns The recomputation result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "recomputeUnlinked(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "recomputeUnlinked" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#searchComponent:member", "docComment": "/**\n * Search input component for filtering results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchComponent: " }, { "kind": "Reference", "text": "SearchComponent", "canonicalReference": "obsidian!SearchComponent:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchComponent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#searchQuery:member", "docComment": "/**\n * Current search query string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchQuery: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchQuery", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#setBacklinkCollapsed:member(1)", "docComment": "/**\n * Set whether the backlink section is collapsed.\n *\n * @returns The result of setting backlink collapsed state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBacklinkCollapsed(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setBacklinkCollapsed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#setCollapseAll:member(1)", "docComment": "/**\n * Set whether all results are collapsed.\n *\n * @returns The result of setting collapse state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapseAll(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setCollapseAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#setExtraContext:member(1)", "docComment": "/**\n * Set whether extra context lines are shown.\n *\n * @returns The result of setting extra context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setExtraContext(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setExtraContext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#setSectionCollapsed:member(1)", "docComment": "/**\n * Set the collapsed state of a specific section.\n *\n * @returns The result of setting the section collapsed state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSectionCollapsed(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg4: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "arg4", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "setSectionCollapsed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#setShowSearch:member(1)", "docComment": "/**\n * Set the visibility of the search filter.\n *\n * @returns The result of toggling search visibility.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setShowSearch(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setShowSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#setSortOrder:member(1)", "docComment": "/**\n * Set the sort order for results.\n *\n * @returns The result of setting sort order.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSortOrder(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSortOrder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#setState:member(1)", "docComment": "/**\n * Restore the component from a saved state.\n *\n * @returns The result of restoring the state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setState(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#setUnlinkedCollapsed:member(1)", "docComment": "/**\n * Set whether the unlinked mentions section is collapsed.\n *\n * @returns The result of setting unlinked collapsed state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUnlinkedCollapsed(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setUnlinkedCollapsed" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#showSearchButtonEl:member", "docComment": "/**\n * Button element to toggle the search filter visibility.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSearchButtonEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showSearchButtonEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#sortOrder:member", "docComment": "/**\n * Current sort order for results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sortOrder: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sortOrder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#stopBacklinkSearch:member(1)", "docComment": "/**\n * Cancel the current backlink search computation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopBacklinkSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopBacklinkSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#stopUnlinkedSearch:member(1)", "docComment": "/**\n * Cancel the current unlinked mentions search computation.\n *\n * @returns The cancellation result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopUnlinkedSearch(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopUnlinkedSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#toggleBacklinkCollapsed:member(1)", "docComment": "/**\n * Toggle the collapsed state of the backlinks section.\n *\n * @returns The toggle result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleBacklinkCollapsed(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleBacklinkCollapsed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#toggleUnlinkedCollapsed:member(1)", "docComment": "/**\n * Toggle the collapsed state of the unlinked mentions section.\n *\n * @returns The toggle result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleUnlinkedCollapsed(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleUnlinkedCollapsed" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#tooltipPlacement:member", "docComment": "/**\n * Placement direction for tooltips.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tooltipPlacement: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tooltipPlacement", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#unlinkedAliases:member", "docComment": "/**\n * Comma-separated aliases used for unlinked mention matching.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unlinkedAliases: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unlinkedAliases", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#unlinkedCollapsed:member", "docComment": "/**\n * Whether the unlinked mentions section is collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unlinkedCollapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unlinkedCollapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#unlinkedCountEl:member", "docComment": "/**\n * Element displaying the count of unlinked mentions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unlinkedCountEl: " }, { "kind": "Reference", "text": "HTMLSpanElement", "canonicalReference": "!HTMLSpanElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unlinkedCountEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#unlinkedDom:member", "docComment": "/**\n * DOM tree rendering unlinked mention search results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unlinkedDom: " }, { "kind": "Reference", "text": "ResultDom", "canonicalReference": "obsidian-typings!ResultDom:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unlinkedDom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#unlinkedFile:member", "docComment": "/**\n * File for which unlinked mentions are being computed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unlinkedFile: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unlinkedFile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#unlinkedHeaderEl:member", "docComment": "/**\n * Header element for the unlinked mentions section.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unlinkedHeaderEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unlinkedHeaderEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkComponent#unlinkedQueue:member", "docComment": "/**\n * Queue of files to process for unlinked mention computation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unlinkedQueue: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unlinkedQueue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#update:member(1)", "docComment": "/**\n * Refresh both backlink and unlinked mention results.\n *\n * @returns The update result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#updateHeaderTooltip:member(1)", "docComment": "/**\n * Update the tooltip text of a section header.\n *\n * @returns The result of updating the header tooltip.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateHeaderTooltip(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "updateHeaderTooltip" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkComponent#updateSearch:member(1)", "docComment": "/**\n * Refresh the search filter and recompute filtered results.\n *\n * @returns The update result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateSearch(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateSearch" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BacklinkPlugin:interface", "docComment": "/**\n * Internal plugin registration for the backlinks feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BacklinkPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BacklinkPluginInstance", "canonicalReference": "obsidian-typings!BacklinkPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/backlink/BacklinkPlugin.d.ts", "releaseTag": "Public", "name": "BacklinkPlugin", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkPlugin#views:member", "docComment": "/**\n * View creators registered by the backlink plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "views: " }, { "kind": "Reference", "text": "BacklinkPluginViews", "canonicalReference": "obsidian-typings!BacklinkPluginViews:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "views", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BacklinkPluginInstance:interface", "docComment": "/**\n * Plugin instance for backlinks, managing backlink view lifecycle and file event handling.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BacklinkPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BacklinkPlugin", "canonicalReference": "obsidian-typings!BacklinkPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/backlink/BacklinkPluginInstance.d.ts", "releaseTag": "Public", "name": "BacklinkPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#file:member", "docComment": "/**\n * The currently tracked file for backlinks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file?: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#initLeaf:member(1)", "docComment": "/**\n * Initialize the backlink view leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initLeaf(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initLeaf" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#onEnable:member(1)", "docComment": "/**\n * Called when the plugin is enabled.\n *\n * @param app - The app instance.\n *\n * @param plugin - The backlink plugin registration.\n *\n * @returns A promise that resolves when the plugin is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEnable(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", plugin: " }, { "kind": "Reference", "text": "BacklinkPlugin", "canonicalReference": "obsidian-typings!BacklinkPlugin:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "plugin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onEnable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Handle external settings file changes and reload configuration.\n *\n * @returns A promise that resolves when the settings are reloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#onFileMenu:member(1)", "docComment": "/**\n * Add backlink-related items to a file context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param file - The target file or folder.\n *\n * @param source - The source of the context menu event.\n *\n * @param leaf - Optional workspace leaf context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", leaf?: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "onFileMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#onFileOpen:member(1)", "docComment": "/**\n * Handle a file being opened and update backlink tracking.\n *\n * @param file - The opened file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileOpen(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#onUserDisable:member(1)", "docComment": "/**\n * Called when the user disables the plugin.\n *\n * @param app - The app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onUserDisable(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onUserDisable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#onUserEnable:member(1)", "docComment": "/**\n * Called when the user enables the plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onUserEnable(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onUserEnable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#openBacklinksForActiveFile:member(1)", "docComment": "/**\n * Open the backlinks pane for the currently active file.\n *\n * @param skipSplit - Whether to skip splitting the pane.\n *\n * @returns Whether the operation succeeded, or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openBacklinksForActiveFile(skipSplit: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "skipSplit", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "openBacklinksForActiveFile" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#options:member", "docComment": "/**\n * Configuration options for the backlink plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "BacklinkPluginInstanceOptions", "canonicalReference": "obsidian-typings!BacklinkPluginInstanceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#plugin:member", "docComment": "/**\n * Reference to the backlink plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "BacklinkPlugin", "canonicalReference": "obsidian-typings!BacklinkPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#toggleBacklinksInDocument:member(1)", "docComment": "/**\n * Toggle the inline backlinks display within the document view.\n *\n * @param skip - Whether to skip the toggle action.\n *\n * @returns Whether the operation succeeded, or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleBacklinksInDocument(skip: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "skip", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toggleBacklinksInDocument" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstance#updateBacklinks:member(1)", "docComment": "/**\n * Refresh the backlink results for the current file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateBacklinks(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateBacklinks" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BacklinkPluginInstanceOptions:interface", "docComment": "/**\n * Configuration options for the backlink plugin instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BacklinkPluginInstanceOptions " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/backlink/BacklinkPluginInstanceOptions.d.ts", "releaseTag": "Public", "name": "BacklinkPluginInstanceOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkPluginInstanceOptions#backlinkInDocument:member", "docComment": "/**\n * Whether to show backlinks inline within the document view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlinkInDocument?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "backlinkInDocument", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BacklinkPluginViews:interface", "docComment": "/**\n * View creators registered by the backlink plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BacklinkPluginViews extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/backlink/BacklinkPluginViews.d.ts", "releaseTag": "Public", "name": "BacklinkPluginViews", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkPluginViews#backlink:member(1)", "docComment": "/**\n * Create a backlink view in the given workspace leaf.\n *\n * @param left - The workspace leaf to create the view in.\n *\n * @returns The created backlink view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlink(left: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BacklinkView", "canonicalReference": "obsidian-typings!BacklinkView:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "left", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "backlink" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BacklinkView:interface", "docComment": "/**\n * {@link obsidian#View} that displays backlinks to the current file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BacklinkView extends " }, { "kind": "Reference", "text": "InfoFileView", "canonicalReference": "obsidian-typings!InfoFileView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/backlink/BacklinkView.d.ts", "releaseTag": "Public", "name": "BacklinkView", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BacklinkView#backlink:member", "docComment": "/**\n * The backlink component rendering linked and unlinked mentions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backlink: " }, { "kind": "Reference", "text": "BacklinkComponent", "canonicalReference": "obsidian-typings!BacklinkComponent:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backlink", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The backlink view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Backlink", "canonicalReference": "obsidian-typings!~__type#Backlink:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkView#showSearch:member(1)", "docComment": "/**\n * Shows the search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BacklinkView#update:member(1)", "docComment": "/**\n * Refresh the backlink results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesConfigFileFilterAndClause:interface", "docComment": "/**\n * {@link obsidian#BasesConfigFileFilter} `and` clause.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesConfigFileFilterAndClause " } ], "fileUrlPath": "src/obsidian/internals/bases/BasesConfigFileFilterAndClause.d.ts", "releaseTag": "Public", "name": "BasesConfigFileFilterAndClause", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesConfigFileFilterAndClause#and:member", "docComment": "/**\n * All of the following filters must match.\n *\n * @example\n * ```ts\n * {\n * and: [\n * '*.md',\n * '*.txt',\n * ],\n * }\n * ```\n *\n * @since\n *\n * 1.10.0\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "and: " }, { "kind": "Reference", "text": "BasesConfigFileFilter", "canonicalReference": "obsidian!BasesConfigFileFilter:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "and", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesConfigFileFilterNotClause:interface", "docComment": "/**\n * {@link obsidian#BasesConfigFileFilter} `not` clause.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesConfigFileFilterNotClause " } ], "fileUrlPath": "src/obsidian/internals/bases/BasesConfigFileFilterNotClause.d.ts", "releaseTag": "Public", "name": "BasesConfigFileFilterNotClause", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesConfigFileFilterNotClause#not:member", "docComment": "/**\n * None of the following filters should match.\n *\n * @example\n * ```ts\n * {\n * not: [\n * '*.md',\n * '*.txt',\n * ],\n * }\n * ```\n *\n * @since\n *\n * 1.10.0\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "not: " }, { "kind": "Reference", "text": "BasesConfigFileFilter", "canonicalReference": "obsidian!BasesConfigFileFilter:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "not", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesConfigFileFilterOrClause:interface", "docComment": "/**\n * {@link obsidian#BasesConfigFileFilter} `or` clause.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesConfigFileFilterOrClause " } ], "fileUrlPath": "src/obsidian/internals/bases/BasesConfigFileFilterOrClause.d.ts", "releaseTag": "Public", "name": "BasesConfigFileFilterOrClause", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesConfigFileFilterOrClause#or:member", "docComment": "/**\n * Some of the following filters should match.\n *\n * @example\n * ```ts\n * {\n * or: [\n * '*.md',\n * '*.txt',\n * ],\n * }\n * ```\n *\n * @since\n *\n * 1.10.0\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "or: " }, { "kind": "Reference", "text": "BasesConfigFileFilter", "canonicalReference": "obsidian!BasesConfigFileFilter:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "or", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesConfigFileViewGroupBy:interface", "docComment": "/**\n * Configuration for grouping the results of a Bases config file view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesConfigFileViewGroupBy " } ], "fileUrlPath": "src/obsidian/internals/bases/BasesConfigFileViewGroupBy.d.ts", "releaseTag": "Public", "name": "BasesConfigFileViewGroupBy", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesContext:interface", "docComment": "/**\n * Bases context\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesContext extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesContext.d.ts", "releaseTag": "Public", "name": "BasesContext", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesContext#_local:member", "docComment": "/**\n * Local context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_local: " }, { "kind": "Reference", "text": "BasesLocal", "canonicalReference": "obsidian-typings!BasesLocal:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_local", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesContext#constructor2__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app instance.\n *\n * @param filter - The filters.\n *\n * @param formulas - The formulas.\n *\n * @param file - The file.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor2__?(\n app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ",\n filter: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ",\n formulas: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ",\n file: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 16, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": false }, { "parameterName": "formulas", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 15 }, "isOptional": false } ], "name": "constructor2__" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesControl:interface", "docComment": "/**\n * Bases control.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesControl " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesControl.d.ts", "releaseTag": "Public", "name": "BasesControl", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesControl#renderTo:member(1)", "docComment": "/**\n * Render to.\n *\n * @param containerEl - The container element.\n *\n * @param renderContext - The render context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderTo(containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", renderContext: " }, { "kind": "Reference", "text": "RenderContext", "canonicalReference": "obsidian!RenderContext:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "containerEl", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "renderContext", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "renderTo" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesController:interface", "docComment": "/**\n * Controller for the view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesController extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesController.d.ts", "releaseTag": "Public", "name": "BasesController", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#addResult:member(1)", "docComment": "/**\n * Adds a result to the results.\n *\n * @param result - The result to add.\n *\n * @returns The add result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addResult(result: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "result", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addResult" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#app:member", "docComment": "/**\n * The Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#buildBasesContext:member(1)", "docComment": "/**\n * Builds the bases context.\n *\n * @param filter - The filter to apply.\n *\n * @returns The constructed bases context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buildBasesContext(filter: " }, { "kind": "Reference", "text": "BasesFilter", "canonicalReference": "obsidian-typings!BasesFilter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BasesContext", "canonicalReference": "obsidian-typings!BasesContext:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "buildBasesContext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#clear:member(1)", "docComment": "/**\n * Clears the view controller.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#clearError:member(1)", "docComment": "/**\n * Clears the error.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearError(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearError" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#ctx:member", "docComment": "/**\n * The context of the view controller.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ctx: " }, { "kind": "Reference", "text": "BasesContext", "canonicalReference": "obsidian-typings!BasesContext:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ctx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#currentFile:member", "docComment": "/**\n * The current file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "currentFile: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "currentFile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#displayError:member(1)", "docComment": "/**\n * Displays an error.\n *\n * @param error - The error message to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayError(error: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "error", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "displayError" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#error:member", "docComment": "/**\n * The current error.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "error: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "error", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#errorEl:member", "docComment": "/**\n * The error element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "errorEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "errorEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#errors:member", "docComment": "/**\n * The errors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "errors: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "errors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#evaluateRelevantProperties:member(1)", "docComment": "/**\n * Evaluates the relevant properties.\n *\n * @param relevantProperties - The property names to evaluate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "evaluateRelevantProperties(relevantProperties: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "relevantProperties", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "evaluateRelevantProperties" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#events:member", "docComment": "/**\n * The events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "events: " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "events", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#filterMenu:member", "docComment": "/**\n * The filter menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filterMenu: " }, { "kind": "Reference", "text": "BasesFilterMenu", "canonicalReference": "obsidian-typings!BasesFilterMenu:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filterMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getActiveBasesViewOfType:member(1)", "docComment": "/**\n * Gets the active bases view of a given type.\n *\n * @param viewType - The view type to search for.\n *\n * @returns The active view of the given type, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getActiveBasesViewOfType(viewType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "viewType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getActiveBasesViewOfType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getCurrentFile:member(1)", "docComment": "/**\n * Gets the current file.\n *\n * @returns The current file, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCurrentFile(): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCurrentFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getEditorLanguageSupport:member(1)", "docComment": "/**\n * Gets the editor language support.\n *\n * @returns The editor language support instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEditorLanguageSupport(): " }, { "kind": "Reference", "text": "EditorLanguageSupport", "canonicalReference": "obsidian-typings!EditorLanguageSupport:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getEditorLanguageSupport" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getMockValue:member(1)", "docComment": "/**\n * Gets the mock value.\n *\n * @returns The mock value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMockValue(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getMockValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getMockValueForIdent:member(1)", "docComment": "/**\n * Gets the mock value for an ident.\n *\n * @returns The mock value for the identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMockValueForIdent(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getMockValueForIdent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getProperties:member(1)", "docComment": "/**\n * Gets the properties.\n *\n * @returns The list of properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getProperties(): " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getProperties" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getQueryViewNames:member(1)", "docComment": "/**\n * Gets the query view names.\n *\n * @returns The list of query view names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getQueryViewNames(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getQueryViewNames" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getViewConfig:member(1)", "docComment": "/**\n * Gets the view config.\n *\n * @returns The view configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewConfig(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewConfig" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#getWidgetForIdent:member(1)", "docComment": "/**\n * Gets the widget for an ident.\n *\n * @param type - The identifier type.\n *\n * @returns The widget type string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getWidgetForIdent(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getWidgetForIdent" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#initialScan:member", "docComment": "/**\n * Whether the initial scan has been completed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialScan: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "initialScan", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#mockContext:member", "docComment": "/**\n * The mock context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mockContext: " }, { "kind": "Reference", "text": "BasesMockContext", "canonicalReference": "obsidian-typings!BasesMockContext:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mockContext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#newItemMenu:member", "docComment": "/**\n * The new item menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newItemMenu: " }, { "kind": "Reference", "text": "BasesNewItemMenu", "canonicalReference": "obsidian-typings!BasesNewItemMenu:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "newItemMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#notifyView:member(1)", "docComment": "/**\n * Notifies the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "notifyView(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "notifyView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#onConfigChanged:member(1)", "docComment": "/**\n * On config changed.\n *\n * @param configKey - The changed configuration key.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onConfigChanged(configKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "configKey", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onConfigChanged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#onResize:member(1)", "docComment": "/**\n * On resize.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#plugin:member", "docComment": "/**\n * The plugin instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "BasesPluginInstance", "canonicalReference": "obsidian-typings!BasesPluginInstance:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#promptForAddView:member(1)", "docComment": "/**\n * Prompt for add view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promptForAddView(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "promptForAddView" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#propertyMenu:member", "docComment": "/**\n * The property menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "propertyMenu: " }, { "kind": "Reference", "text": "BasesPropertyMenu", "canonicalReference": "obsidian-typings!BasesPropertyMenu:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "propertyMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#query:member", "docComment": "/**\n * The query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#queryState:member", "docComment": "/**\n * The query state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queryState: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queryState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#queue:member", "docComment": "/**\n * The queue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queue: " }, { "kind": "Reference", "text": "PromisedQueue", "canonicalReference": "obsidian-typings!PromisedQueue:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#relevantProperties:member", "docComment": "/**\n * The relevant properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "relevantProperties: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "relevantProperties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#removeResult:member(1)", "docComment": "/**\n * Removes a result.\n *\n * @returns The removal result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeResult(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeResult" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#requestNotifyView:member", "docComment": "/**\n * The request to notify the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestNotifyView: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestNotifyView", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#results:member", "docComment": "/**\n * The results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "results: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "BasesEntry", "canonicalReference": "obsidian!BasesEntry:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "results", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#resultsMenu:member", "docComment": "/**\n * The results menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resultsMenu: " }, { "kind": "Reference", "text": "BasesResultsMenu", "canonicalReference": "obsidian-typings!BasesResultsMenu:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resultsMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#runQuery:member(1)", "docComment": "/**\n * Runs a query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "runQuery(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "runQuery" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#selectView:member(1)", "docComment": "/**\n * Selects a view.\n *\n * @param viewName - The name of the view to select.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectView(viewName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "viewName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "selectView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#setQuery:member(1)", "docComment": "/**\n * Sets the query.\n *\n * @param queryOrError - The query or error to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setQuery(queryOrError: " }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "queryOrError", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "setQuery" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#setQueryAndView:member(1)", "docComment": "/**\n * Sets the query and view.\n *\n * @param queryOrError - The query or error to set.\n *\n * @param viewName - The name of the view to select.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setQueryAndView(queryOrError: " }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ", viewName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "queryOrError", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false }, { "parameterName": "viewName", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "setQueryAndView" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#sortMenu:member", "docComment": "/**\n * The sort menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sortMenu: " }, { "kind": "Reference", "text": "BasesSortMenu", "canonicalReference": "obsidian-typings!BasesSortMenu:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sortMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#startLoader:member(1)", "docComment": "/**\n * Starts the loader.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startLoader(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "startLoader" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#stopLoader:member(1)", "docComment": "/**\n * Stops the loader.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopLoader(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopLoader" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#update:member(1)", "docComment": "/**\n * Updates the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesController#updateCurrentFile:member(1)", "docComment": "/**\n * Updates the current file.\n *\n * @param file - The file to set as current.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateCurrentFile(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateCurrentFile" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#view:member", "docComment": "/**\n * The view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "view: " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#viewContainerEl:member", "docComment": "/**\n * The view container element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewContainerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewContainerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#viewEstates:member", "docComment": "/**\n * The view states.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewEstates: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewEstates", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#viewHeaderEl:member", "docComment": "/**\n * The view header element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewHeaderEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewHeaderEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#viewMenu:member", "docComment": "/**\n * The view menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewMenu: " }, { "kind": "Reference", "text": "BasesViewMenu", "canonicalReference": "obsidian-typings!BasesViewMenu:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesController#viewName:member", "docComment": "/**\n * The view name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesExternalLink:interface", "docComment": "/**\n * Bases external link.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesExternalLink extends " }, { "kind": "Reference", "text": "BasesControl", "canonicalReference": "obsidian-typings!BasesControl:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesExternalLink.d.ts", "releaseTag": "Public", "name": "BasesExternalLink", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesFile:interface", "docComment": "/**\n * Bases file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesFile extends " }, { "kind": "Reference", "text": "BasesControl", "canonicalReference": "obsidian-typings!BasesControl:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesFile.d.ts", "releaseTag": "Public", "name": "BasesFile", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesFile#getLinks:member(1)", "docComment": "/**\n * Gets the links.\n *\n * @returns The links.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLinks(): " }, { "kind": "Reference", "text": "BasesList", "canonicalReference": "obsidian-typings!BasesList:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLinks" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesFilter:interface", "docComment": "/**\n * Bases filter.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesFilter " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesFilter.d.ts", "releaseTag": "Public", "name": "BasesFilter", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesFilterMenu:interface", "docComment": "/**\n * Bases filter menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesFilterMenu " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesFilterMenu.d.ts", "releaseTag": "Public", "name": "BasesFilterMenu", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesFormula:interface", "docComment": "/**\n * Bases formula.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesFormula " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesFormula.d.ts", "releaseTag": "Public", "name": "BasesFormula", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesFunction:interface", "docComment": "/**\n * Bases function.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesFunction " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesFunction.d.ts", "releaseTag": "Public", "name": "BasesFunction", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunction#app:member", "docComment": "/**\n * An Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesFunction#apply:member(1)", "docComment": "/**\n * Applies the function.\n *\n * @param args - The arguments to apply.\n *\n * @returns The result of applying the function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "apply(...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "apply" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunction#args:member", "docComment": "/**\n * The arguments.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args: " }, { "kind": "Reference", "text": "BasesFunctionArg", "canonicalReference": "obsidian-typings!BasesFunctionArg:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunction#isOperator:member", "docComment": "/**\n * Whether the function is an operator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isOperator: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isOperator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunction#name:member", "docComment": "/**\n * The name of the function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunction#returnType:member", "docComment": "/**\n * The return type of the function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "returnType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "returnType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesFunction#serialize:member(1)", "docComment": "/**\n * Serializes the function.\n *\n * @param args - The arguments to serialize.\n *\n * @returns The serialized function string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialize(...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "serialize" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesFunctionArg:interface", "docComment": "/**\n * Bases function argument.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesFunctionArg " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesFunctionArg.d.ts", "releaseTag": "Public", "name": "BasesFunctionArg", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctionArg#includeCustomTypes:member", "docComment": "/**\n * Whether to include custom types.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "includeCustomTypes?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "includeCustomTypes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctionArg#name:member", "docComment": "/**\n * The name of the argument.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctionArg#optional:member", "docComment": "/**\n * Whether the argument is optional.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "optional?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "optional", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctionArg#type:member", "docComment": "/**\n * The types of the argument.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctionArg#variadic:member", "docComment": "/**\n * Whether the argument is variadic.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "variadic?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "variadic", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesFunctions:interface", "docComment": "/**\n * Bases functions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesFunctions " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesFunctions.d.ts", "releaseTag": "Public", "name": "BasesFunctions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#\"!=\":member", "docComment": "/**\n * The not equal function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'!=': " }, { "kind": "Reference", "text": "NotEqualFunction", "canonicalReference": "obsidian-typings!NotEqualFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\"!=\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#\"<\":member", "docComment": "/**\n * The less than function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'<': " }, { "kind": "Reference", "text": "LessFunction", "canonicalReference": "obsidian-typings!LessFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\"<\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#\"<=\":member", "docComment": "/**\n * The less than or equal to function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'<=': " }, { "kind": "Reference", "text": "LessOrEqualFunction", "canonicalReference": "obsidian-typings!LessOrEqualFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\"<=\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#\"==\":member", "docComment": "/**\n * The equal function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'==': " }, { "kind": "Reference", "text": "EqualFunction", "canonicalReference": "obsidian-typings!EqualFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\"==\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#\">\":member", "docComment": "/**\n * The greater than function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'>': " }, { "kind": "Reference", "text": "GreaterFunction", "canonicalReference": "obsidian-typings!GreaterFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\">\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#\">=\":member", "docComment": "/**\n * The greater than or equal to function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'>=': " }, { "kind": "Reference", "text": "GreaterOrEqualFunction", "canonicalReference": "obsidian-typings!GreaterOrEqualFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\">=\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#abs:member", "docComment": "/**\n * The absolute function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'abs': " }, { "kind": "Reference", "text": "AbsFunction", "canonicalReference": "obsidian-typings!AbsFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "abs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#ceil:member", "docComment": "/**\n * The ceiling function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'ceil': " }, { "kind": "Reference", "text": "CeilFunction", "canonicalReference": "obsidian-typings!CeilFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ceil", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#concat:member", "docComment": "/**\n * The concat function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'concat': " }, { "kind": "Reference", "text": "ConcatFunction", "canonicalReference": "obsidian-typings!ConcatFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "concat", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#contains:member", "docComment": "/**\n * The contains function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'contains': " }, { "kind": "Reference", "text": "ContainsFunction", "canonicalReference": "obsidian-typings!ContainsFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contains", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#containsAll:member", "docComment": "/**\n * The contains all function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'containsAll': " }, { "kind": "Reference", "text": "ContainsAllFunction", "canonicalReference": "obsidian-typings!ContainsAllFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containsAll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#containsAny:member", "docComment": "/**\n * The contains any function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'containsAny': " }, { "kind": "Reference", "text": "ContainsAnyFunction", "canonicalReference": "obsidian-typings!ContainsAnyFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containsAny", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#containsNone:member", "docComment": "/**\n * The contains none function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'containsNone': " }, { "kind": "Reference", "text": "ContainsNoneFunction", "canonicalReference": "obsidian-typings!ContainsNoneFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containsNone", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#dateAfter:member", "docComment": "/**\n * The date after function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'dateAfter': " }, { "kind": "Reference", "text": "DateAfterFunction", "canonicalReference": "obsidian-typings!DateAfterFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dateAfter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#dateBefore:member", "docComment": "/**\n * The date before function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'dateBefore': " }, { "kind": "Reference", "text": "DateBeforeFunction", "canonicalReference": "obsidian-typings!DateBeforeFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dateBefore", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#dateDiff:member", "docComment": "/**\n * The date diff function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'dateDiff': " }, { "kind": "Reference", "text": "DateDiffFunction", "canonicalReference": "obsidian-typings!DateDiffFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dateDiff", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#dateEquals:member", "docComment": "/**\n * The date equals function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'dateEquals': " }, { "kind": "Reference", "text": "DateEqualsFunction", "canonicalReference": "obsidian-typings!DateEqualsFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dateEquals", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#dateModify:member", "docComment": "/**\n * The date modify function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'dateModify': " }, { "kind": "Reference", "text": "DateModifyFunction", "canonicalReference": "obsidian-typings!DateModifyFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dateModify", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#dateNotEquals:member", "docComment": "/**\n * The date not equals function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'dateNotEquals': " }, { "kind": "Reference", "text": "DateNotEqualsFunction", "canonicalReference": "obsidian-typings!DateNotEqualsFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dateNotEquals", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#dateOnOrAfter:member", "docComment": "/**\n * The date on or after function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'dateOnOrAfter': " }, { "kind": "Reference", "text": "DateOnOrAfterFunction", "canonicalReference": "obsidian-typings!DateOnOrAfterFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dateOnOrAfter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#dateOnOrBefore:member", "docComment": "/**\n * The date on or before function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'dateOnOrBefore': " }, { "kind": "Reference", "text": "DateOnOrBeforeFunction", "canonicalReference": "obsidian-typings!DateOnOrBeforeFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dateOnOrBefore", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#day:member", "docComment": "/**\n * The day function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'day': " }, { "kind": "Reference", "text": "DayFunction", "canonicalReference": "obsidian-typings!DayFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "day", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#empty:member", "docComment": "/**\n * The empty function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'empty': " }, { "kind": "Reference", "text": "EmptyFunction", "canonicalReference": "obsidian-typings!EmptyFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "empty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#flat:member", "docComment": "/**\n * The flat function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'flat': " }, { "kind": "Reference", "text": "FlatFunction", "canonicalReference": "obsidian-typings!FlatFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "flat", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#floor:member", "docComment": "/**\n * The floor function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'floor': " }, { "kind": "Reference", "text": "FloorFunction", "canonicalReference": "obsidian-typings!FloorFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "floor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#hour:member", "docComment": "/**\n * The hour function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'hour': " }, { "kind": "Reference", "text": "HourFunction", "canonicalReference": "obsidian-typings!HourFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hour", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#if:member", "docComment": "/**\n * The if function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'if': " }, { "kind": "Reference", "text": "IfFunction", "canonicalReference": "obsidian-typings!IfFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "if", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#index:member", "docComment": "/**\n * The index function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'index': " }, { "kind": "Reference", "text": "IndexFunction", "canonicalReference": "obsidian-typings!IndexFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "index", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#inFolder:member", "docComment": "/**\n * The in folder function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'inFolder': " }, { "kind": "Reference", "text": "InFolderFunction", "canonicalReference": "obsidian-typings!InFolderFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inFolder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#join:member", "docComment": "/**\n * The join function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'join': " }, { "kind": "Reference", "text": "JoinFunction", "canonicalReference": "obsidian-typings!JoinFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "join", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#len:member", "docComment": "/**\n * The length function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'len': " }, { "kind": "Reference", "text": "LenFunction", "canonicalReference": "obsidian-typings!LenFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "len", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#linksTo:member", "docComment": "/**\n * The links to function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'linksTo': " }, { "kind": "Reference", "text": "LinksToFunction", "canonicalReference": "obsidian-typings!LinksToFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "linksTo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#min:member", "docComment": "/**\n * The minimum function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'min': " }, { "kind": "Reference", "text": "MinFunction", "canonicalReference": "obsidian-typings!MinFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "min", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#minute:member", "docComment": "/**\n * The minute function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'minute': " }, { "kind": "Reference", "text": "MinuteFunction", "canonicalReference": "obsidian-typings!MinuteFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minute", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#month:member", "docComment": "/**\n * The month function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'month': " }, { "kind": "Reference", "text": "MonthFunction", "canonicalReference": "obsidian-typings!MonthFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "month", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#not:member", "docComment": "/**\n * The not function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'not': " }, { "kind": "Reference", "text": "NotFunction", "canonicalReference": "obsidian-typings!NotFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "not", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#notContains:member", "docComment": "/**\n * The not contains function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'notContains': " }, { "kind": "Reference", "text": "NotContainsFunction", "canonicalReference": "obsidian-typings!NotContainsFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "notContains", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#notEmpty:member", "docComment": "/**\n * The not empty function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'notEmpty': " }, { "kind": "Reference", "text": "NotEmptyFunction", "canonicalReference": "obsidian-typings!NotEmptyFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "notEmpty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#now:member", "docComment": "/**\n * The now function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'now': " }, { "kind": "Reference", "text": "NowFunction", "canonicalReference": "obsidian-typings!NowFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "now", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#round:member", "docComment": "/**\n * The round function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'round': " }, { "kind": "Reference", "text": "RoundFunction", "canonicalReference": "obsidian-typings!RoundFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "round", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#second:member", "docComment": "/**\n * The second function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'second': " }, { "kind": "Reference", "text": "SecondFunction", "canonicalReference": "obsidian-typings!SecondFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "second", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#slice:member", "docComment": "/**\n * The slice function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'slice': " }, { "kind": "Reference", "text": "SliceFunction", "canonicalReference": "obsidian-typings!SliceFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "slice", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#taggedWith:member", "docComment": "/**\n * The tagged with function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'taggedWith': " }, { "kind": "Reference", "text": "TaggedWithFunction", "canonicalReference": "obsidian-typings!TaggedWithFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "taggedWith", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#title:member", "docComment": "/**\n * The title function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'title': " }, { "kind": "Reference", "text": "TitleFunction", "canonicalReference": "obsidian-typings!TitleFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#trim:member", "docComment": "/**\n * The trim function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'trim': " }, { "kind": "Reference", "text": "TrimFunction", "canonicalReference": "obsidian-typings!TrimFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "trim", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#unique:member", "docComment": "/**\n * The unique function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'unique': " }, { "kind": "Reference", "text": "UniqueFunction", "canonicalReference": "obsidian-typings!UniqueFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unique", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesFunctions#year:member", "docComment": "/**\n * The year function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'year': " }, { "kind": "Reference", "text": "YearFunction", "canonicalReference": "obsidian-typings!YearFunction:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "year", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesHandlers:interface", "docComment": "/**\n * Bases handlers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesHandlers extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesHandlers.d.ts", "releaseTag": "Public", "name": "BasesHandlers", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesHandlers#table:member", "docComment": "/**\n * The table view factory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "table: " }, { "kind": "Reference", "text": "ViewFactory", "canonicalReference": "obsidian-typings!ViewFactory:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TableView", "canonicalReference": "obsidian-typings!TableView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "table", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesLink:interface", "docComment": "/**\n * Bases link.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesLink extends " }, { "kind": "Reference", "text": "BasesControl", "canonicalReference": "obsidian-typings!BasesControl:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesLink.d.ts", "releaseTag": "Public", "name": "BasesLink", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesLink#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app instance.\n *\n * @param linkText - The link text.\n *\n * @param sourcePath - The source path.\n *\n * @param displayText - The display text.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", sourcePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", displayText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "linkText", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "sourcePath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "displayText", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesLink#link:member", "docComment": "/**\n * The link.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "link: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "link", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesLinkConstructor:interface", "docComment": "/**\n * Bases link constructor.\n *\n * Extends {@link ExtractConstructor} with a static `parseFromString` method.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesLinkConstructor extends " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesLink", "canonicalReference": "obsidian-typings!BasesLink:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/constructors/BasesLinkConstructor.d.ts", "releaseTag": "Public", "name": "BasesLinkConstructor", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesLinkConstructor#parseFromString:member(1)", "docComment": "/**\n * Parse {@link BasesLink} from string.\n *\n * @param app - The Obsidian application instance.\n *\n * @param str - The string to parse.\n *\n * @param sourcePath - The source path.\n *\n * @returns The parsed {@link BasesLink}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parseFromString(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", str: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", sourcePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BasesLink", "canonicalReference": "obsidian-typings!BasesLink:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "str", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "sourcePath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "parseFromString" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesList:interface", "docComment": "/**\n * Bases list.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesList extends " }, { "kind": "Reference", "text": "BasesControl", "canonicalReference": "obsidian-typings!BasesControl:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesList.d.ts", "releaseTag": "Public", "name": "BasesList", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesList#data:member", "docComment": "/**\n * The controls.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesList#get:member(1)", "docComment": "/**\n * Gets a value by key.\n *\n * @param key - The key.\n *\n * @returns The value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BasesControl", "canonicalReference": "obsidian-typings!BasesControl:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "get" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesLocal:interface", "docComment": "/**\n * Bases local.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesLocal " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesLocal.d.ts", "releaseTag": "Public", "name": "BasesLocal", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesLocal#implicit:member", "docComment": "/**\n * Implicit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "implicit: " }, { "kind": "Reference", "text": "BasesFile", "canonicalReference": "obsidian-typings!BasesFile:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "implicit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesLocal#note:member", "docComment": "/**\n * Note.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "note: " }, { "kind": "Reference", "text": "BasesNote", "canonicalReference": "obsidian-typings!BasesNote:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "note", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesMockContext:interface", "docComment": "/**\n * Bases view controller mock context.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesMockContext " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesMockContext.d.ts", "releaseTag": "Public", "name": "BasesMockContext", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesNewItemMenu:interface", "docComment": "/**\n * Bases view controller new item menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesNewItemMenu " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesNewItemMenu.d.ts", "releaseTag": "Public", "name": "BasesNewItemMenu", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesNote:interface", "docComment": "/**\n * Bases note.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesNote " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesNote.d.ts", "releaseTag": "Public", "name": "BasesNote", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesNote#data:member", "docComment": "/**\n * Data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesNote#get:member(1)", "docComment": "/**\n * Get control.\n *\n * @param key - The key.\n *\n * @returns The control.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BasesControl", "canonicalReference": "obsidian-typings!BasesControl:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "get" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesPlugin:interface", "docComment": "/**\n * Bases plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesPluginInstance", "canonicalReference": "obsidian-typings!BasesPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesPlugin.d.ts", "releaseTag": "Public", "name": "BasesPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesPluginInstance:interface", "docComment": "/**\n * Bases plugin instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesPlugin", "canonicalReference": "obsidian-typings!BasesPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesPluginInstance.d.ts", "releaseTag": "Public", "name": "BasesPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#app:member", "docComment": "/**\n * An Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#createAndEmbedBase:member(1)", "docComment": "/**\n * Creates and embeds a base.\n *\n * @param editor - The editor to embed the base into.\n *\n * @returns A promise that resolves when the base is created and embedded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createAndEmbedBase(editor: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createAndEmbedBase" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#createNewBasesFile:member(1)", "docComment": "/**\n * Creates a new bases file.\n *\n * @param location - Optional folder location for the new file.\n *\n * @param filename - Optional filename for the new file.\n *\n * @param contents - Optional initial contents.\n *\n * @returns The created file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createNewBasesFile(location?: " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": ", filename?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", contents?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "location", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "filename", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "contents", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "createNewBasesFile" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#defaultOn:member", "docComment": "/**\n * Whether the default on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#deregisterFunction:member(1)", "docComment": "/**\n * Deregisters a function.\n *\n * @param name - The name of the function to deregister.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deregisterFunction(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "deregisterFunction" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#deregisterView:member(1)", "docComment": "/**\n * Deregisters a view.\n *\n * @param type - The view type to deregister.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deregisterView(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "deregisterView" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#functions:member", "docComment": "/**\n * The functions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "functions: " }, { "kind": "Reference", "text": "BasesFunctions", "canonicalReference": "obsidian-typings!BasesFunctions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "functions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#getFunction:member(1)", "docComment": "/**\n * Gets a function.\n *\n * @param name - The name of the function to get.\n *\n * @returns The function, or `null` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFunction(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFunction" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#getOperatorFunctions:member(1)", "docComment": "/**\n * Gets the operator functions.\n *\n * @returns The list of operator functions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOperatorFunctions(): " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getOperatorFunctions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#getViewFactory:member(1)", "docComment": "/**\n * Gets a view factory.\n *\n * @param type - The view type to get the factory for.\n *\n * @returns The view factory, or `null` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewFactory(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "ViewFactory", "canonicalReference": "obsidian-typings!ViewFactory:type" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getViewFactory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#getViewTypes:member(1)", "docComment": "/**\n * Gets the view types.\n *\n * @returns The list of registered view type strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewTypes(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewTypes" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#handlers:member", "docComment": "/**\n * The handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handlers: " }, { "kind": "Reference", "text": "BasesHandlers", "canonicalReference": "obsidian-typings!BasesHandlers:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "handlers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#onFileMenu:member(1)", "docComment": "/**\n * On file menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param file - The target file or folder.\n *\n * @param source - The source of the context menu event.\n *\n * @param leaf - Optional workspace leaf context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", leaf?: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "onFileMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#registerFunction:member(1)", "docComment": "/**\n * Registers a function.\n *\n * @param fn - The function to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerFunction(fn: " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "registerFunction" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesPluginInstance#registerView:member(1)", "docComment": "/**\n * Registers a view.\n *\n * @param type - The view type identifier.\n *\n * @param viewFactory - The factory function to create the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerView(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", viewFactory: " }, { "kind": "Reference", "text": "ViewFactory", "canonicalReference": "obsidian-typings!ViewFactory:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "viewFactory", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "registerView" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesProperty:interface", "docComment": "/**\n * Bases property.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesProperty " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesProperty.d.ts", "releaseTag": "Public", "name": "BasesProperty", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesProperty#getDisplayName:member(1)", "docComment": "/**\n * Gets the display name.\n *\n * @returns The display name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDisplayName(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDisplayName" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesProperty#migrateDisplayName:member(1)", "docComment": "/**\n * Migrates the display name.\n *\n * @param getDisplayName - The display name to migrate.\n *\n * @returns The migrated display name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "migrateDisplayName(getDisplayName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "getDisplayName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "migrateDisplayName" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesProperty#propertyId:member", "docComment": "/**\n * The property ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "propertyId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "propertyId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesProperty#query:member", "docComment": "/**\n * The query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesProperty#serialize:member(1)", "docComment": "/**\n * Serializes the property.\n *\n * @returns The serialized property data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialize(): " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "serialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesProperty#setDisplayName:member(1)", "docComment": "/**\n * Sets the display name.\n *\n * @param displayName - The display name to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDisplayName(displayName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "displayName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setDisplayName" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesProperty#unrecognizedData:member", "docComment": "/**\n * The unrecognized data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unrecognizedData: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unrecognizedData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesPropertyMenu:interface", "docComment": "/**\n * Bases view controller property menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesPropertyMenu " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesPropertyMenu.d.ts", "releaseTag": "Public", "name": "BasesPropertyMenu", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesQuery:interface", "docComment": "/**\n * Bases query.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesQuery " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesQuery.d.ts", "releaseTag": "Public", "name": "BasesQuery", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#clone:member(1)", "docComment": "/**\n * Clones the query.\n *\n * @returns The cloned query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clone(): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clone" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#constructor__:member(1)", "docComment": "/**\n * Creates a new instance.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesQuery#formulas:member", "docComment": "/**\n * The formulas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "formulas: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "formulas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#getPropertyConfig:member(1)", "docComment": "/**\n * Gets the property config.\n *\n * @param key - The property key.\n *\n * @returns The property configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPropertyConfig(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPropertyConfig" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#getSerializable:member(1)", "docComment": "/**\n * Gets the serializable data.\n *\n * @returns The serializable data object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSerializable(): " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSerializable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#getViewConfig:member(1)", "docComment": "/**\n * Gets the view config.\n *\n * @param key - The view config key.\n *\n * @returns The view configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewConfig(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getViewConfig" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesQuery#properties:member", "docComment": "/**\n * The properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#removeFormula:member(1)", "docComment": "/**\n * Removes a formula.\n *\n * @param key - The formula key to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeFormula(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeFormula" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#save:member(1)", "docComment": "/**\n * Saves the query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "save(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "save" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#saveFn:member(1)", "docComment": "/**\n * Saves the query.\n *\n * @param query - The query instance to save.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveFn(query: " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "saveFn" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#setFormulas:member(1)", "docComment": "/**\n * Sets the formulas.\n *\n * @param formulas - The formulas to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFormulas(formulas: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "formulas", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "name": "setFormulas" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#setGlobalFilters:member(1)", "docComment": "/**\n * Sets the global filters.\n *\n * @param filter - The global filter to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setGlobalFilters(filter: " }, { "kind": "Reference", "text": "BasesFilter", "canonicalReference": "obsidian-typings!BasesFilter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setGlobalFilters" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQuery#setViewFilters:member(1)", "docComment": "/**\n * Sets the view filters.\n *\n * @param key - The view key.\n *\n * @param filters - The filters to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setViewFilters(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", filters: " }, { "kind": "Reference", "text": "BasesFilter", "canonicalReference": "obsidian-typings!BasesFilter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "filters", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setViewFilters" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesQuery#unrecognizedData:member", "docComment": "/**\n * The unrecognized data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unrecognizedData: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unrecognizedData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesQuery#views:member", "docComment": "/**\n * The views.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "views: " }, { "kind": "Reference", "text": "BasesSubView", "canonicalReference": "obsidian-typings!BasesSubView:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "views", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesQueryConstructor:interface", "docComment": "/**\n * Bases query constructor.\n *\n * Extends {@link ExtractConstructor} with a static `fromString` parser (the `.base` parser). `BasesQuery` is not part of the public `obsidian` module, so its constructor is modeled here rather than obtained from `obsidian` directly.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesQueryConstructor extends " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/constructors/BasesQueryConstructor.d.ts", "releaseTag": "Public", "name": "BasesQueryConstructor", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQueryConstructor#fromString:member(1)", "docComment": "/**\n * Parse a `.base` file's content into a {@link BasesQuery}.\n *\n * @param content - The `.base` file content.\n *\n * @returns The parsed query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromString(content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "fromString" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesQueryQueue:interface", "docComment": "/**\n * The file-change queue that streams vault files into a {@link obsidian#QueryController}'s query and keeps the results in sync as files are created, modified, renamed, or deleted.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesQueryQueue extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesQueryQueue.d.ts", "releaseTag": "Public", "name": "BasesQueryQueue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesQueryQueue#app:member", "docComment": "/**\n * The app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesQueryQueue#dom:member", "docComment": "/**\n * The owning query controller, to which scan progress and removed results are reported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dom: " }, { "kind": "Reference", "text": "QueryController", "canonicalReference": "obsidian!QueryController:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQueryQueue#onFileChanged:member(1)", "docComment": "/**\n * Re-queues a renamed file or a file whose metadata cache changed.\n *\n * @param file - The changed file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileChanged(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileChanged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQueryQueue#onFileDeleted:member(1)", "docComment": "/**\n * Removes a deleted file from the queue and from the results.\n *\n * @param file - The deleted file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileDeleted(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileDeleted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQueryQueue#onNonMarkdownFileChanged:member(1)", "docComment": "/**\n * Queues a created or modified non-markdown file.\n *\n * @param file - The changed file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onNonMarkdownFileChanged(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onNonMarkdownFileChanged" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesQueryQueue#queue:member", "docComment": "/**\n * The inner cancellable batch queue that drives the scan, or `null` when the queue is stopped.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queue: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQueryQueue#start:member(1)", "docComment": "/**\n * Starts a new scan, enqueuing every file in the vault.\n *\n * @returns The inner cancellable batch queue driving the scan.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "start" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesQueryQueue#stop:member(1)", "docComment": "/**\n * Stops and cancels the current scan.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stop(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stop" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesResultsMenu:interface", "docComment": "/**\n * Bases view controller results menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesResultsMenu " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesResultsMenu.d.ts", "releaseTag": "Public", "name": "BasesResultsMenu", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesSearchMenu:interface", "docComment": "/**\n * The search menu of a {@link obsidian#QueryController}'s toolbar, providing the in-view search bar that filters results by a full-text query.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesSearchMenu extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesSearchMenu.d.ts", "releaseTag": "Public", "name": "BasesSearchMenu", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#_isOpen:member", "docComment": "/**\n * Whether the search bar is currently open.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_isOpen: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_isOpen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#app:member", "docComment": "/**\n * The app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#button:member", "docComment": "/**\n * The toolbar button that toggles the search bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "button: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "button", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#close:member(1)", "docComment": "/**\n * Closes the search bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "close" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#countEl:member", "docComment": "/**\n * The element displaying the search result count.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "countEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "countEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#inputEl:member", "docComment": "/**\n * The search input element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#open:member(1)", "docComment": "/**\n * Opens the search bar, focuses the input, and pushes the keyboard scope.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "open(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "open" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#queryController:member", "docComment": "/**\n * The owning query controller.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queryController: " }, { "kind": "Reference", "text": "QueryController", "canonicalReference": "obsidian!QueryController:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queryController", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#scope:member", "docComment": "/**\n * The keyboard scope active while the search bar is open (registers `Escape` to close it).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scope: " }, { "kind": "Reference", "text": "Scope", "canonicalReference": "obsidian!Scope:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#searchBarEl:member", "docComment": "/**\n * The search bar container element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchBarEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchBarEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#toggle:member(1)", "docComment": "/**\n * Toggles the search bar open or closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggle(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#update:member", "docComment": "/**\n * Debounced update that pushes the typed query to the controller via {@link obsidian#QueryController.updateSearchQuery}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[string], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "update", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSearchMenu#updateCount:member(1)", "docComment": "/**\n * Updates the displayed result count.\n *\n * @param entries - The filtered entries whose count to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateCount(entries: " }, { "kind": "Reference", "text": "BasesEntry", "canonicalReference": "obsidian!BasesEntry:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "entries", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "updateCount" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesSortMenu:interface", "docComment": "/**\n * Bases view controller sort menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesSortMenu " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesSortMenu.d.ts", "releaseTag": "Public", "name": "BasesSortMenu", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesSubView:interface", "docComment": "/**\n * Bases sub view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesSubView " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesSubView.d.ts", "releaseTag": "Public", "name": "BasesSubView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#clone:member(1)", "docComment": "/**\n * Clones the sub view.\n *\n * @param name - The name for the cloned sub view.\n *\n * @returns The cloned sub view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clone(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "clone" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#get:member(1)", "docComment": "/**\n * Gets the sub view.\n *\n * @returns The sub view value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#getAll:member(1)", "docComment": "/**\n * Gets all the sub views.\n *\n * @returns All sub view entries.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAll(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#getDisplayName:member(1)", "docComment": "/**\n * Gets the display name.\n *\n * @returns The display name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDisplayName(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDisplayName" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#getLimit:member(1)", "docComment": "/**\n * Gets the limit.\n *\n * @returns The current limit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLimit(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLimit" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#getOrder:member(1)", "docComment": "/**\n * Gets the order.\n *\n * @returns The current sort order.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOrder(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getOrder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#getPropertyConfig:member(1)", "docComment": "/**\n * Gets the property config.\n *\n * @returns The property configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPropertyConfig(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPropertyConfig" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#getSort:member(1)", "docComment": "/**\n * Gets the sort.\n *\n * @returns The current sort configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSort(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSort" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#getViewName:member(1)", "docComment": "/**\n * Gets the view name.\n *\n * @returns The view name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewName(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewName" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSubView#name:member", "docComment": "/**\n * The name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSubView#query:member", "docComment": "/**\n * The query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#serialize:member(1)", "docComment": "/**\n * Serializes the sub view.\n *\n * @returns The serialized sub view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialize(): " }, { "kind": "Reference", "text": "SerializedBasesSubView", "canonicalReference": "obsidian-typings!SerializedBasesSubView:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "serialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#set:member(1)", "docComment": "/**\n * Sets the sub view.\n *\n * @returns The set result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "set(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "set" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#setLimit:member(1)", "docComment": "/**\n * Sets the limit.\n *\n * @returns The set result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setLimit(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setLimit" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#setOrder:member(1)", "docComment": "/**\n * Sets the order.\n *\n * @returns The set result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOrder(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setOrder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesSubView#setSortProperty:member(1)", "docComment": "/**\n * Sets the sort property.\n *\n * @returns The set result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSortProperty(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setSortProperty" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesSubView#type:member", "docComment": "/**\n * The type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesView:interface", "docComment": "/**\n * View for the `Bases` plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesView extends " }, { "kind": "Reference", "text": "TextFileView", "canonicalReference": "obsidian!TextFileView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesView.d.ts", "releaseTag": "Public", "name": "BasesView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesView#constructor4__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param leaf - The workspace leaf.\n *\n * @param basesPluginInstance - The bases plugin instance.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor4__?(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", basesPluginInstance: " }, { "kind": "Reference", "text": "BasesPluginInstance", "canonicalReference": "obsidian-typings!BasesPluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "basesPluginInstance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor4__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesView#controller:member", "docComment": "/**\n * The controller for the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "controller: " }, { "kind": "Reference", "text": "BasesController", "canonicalReference": "obsidian-typings!BasesController:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "controller", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesView#getViewType:member(1)", "docComment": "/**\n * Get view type.\n *\n * @returns The bases view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Bases", "canonicalReference": "obsidian-typings!~__type#Bases:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesView#lastData:member", "docComment": "/**\n * The last data of the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastData: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesView#onLayoutChange:member(1)", "docComment": "/**\n * Called when the layout of the view changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onLayoutChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onLayoutChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesView#onViewChanged:member(1)", "docComment": "/**\n * Called when the view changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onViewChanged(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onViewChanged" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesView#plugin:member", "docComment": "/**\n * Bases plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "BasesPluginInstance", "canonicalReference": "obsidian-typings!BasesPluginInstance:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BasesView#query:member", "docComment": "/**\n * The query for the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesView#receiveSyncState:member(1)", "docComment": "/**\n * Receives the sync state.\n *\n * @param fileView - The file view to receive the sync state from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "receiveSyncState(fileView: " }, { "kind": "Reference", "text": "FileView", "canonicalReference": "obsidian!FileView:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fileView", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "receiveSyncState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesView#saveQuery:member(1)", "docComment": "/**\n * Saves the query.\n *\n * @param query - The query to save.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveQuery(query: " }, { "kind": "Reference", "text": "BasesQuery", "canonicalReference": "obsidian-typings!BasesQuery:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "saveQuery" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BasesView#updateCurrentFile:member(1)", "docComment": "/**\n * Updates the current file.\n *\n * @param file - The file to update.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateCurrentFile(file: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "updateCurrentFile" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BasesViewMenu:interface", "docComment": "/**\n * Bases view menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BasesViewMenu " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/BasesViewMenu.d.ts", "releaseTag": "Public", "name": "BasesViewMenu", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BBox:interface", "docComment": "/**\n * Axis-aligned bounding box.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BBox " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/BBox.d.ts", "releaseTag": "Public", "name": "BBox", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BBox#maxX:member", "docComment": "/**\n * Maximum x coordinate (right edge).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "maxX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BBox#maxY:member", "docComment": "/**\n * Maximum y coordinate (bottom edge).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "maxY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BBox#minX:member", "docComment": "/**\n * Minimum x coordinate (left edge).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BBox#minY:member", "docComment": "/**\n * Minimum y coordinate (top edge).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Bezier:interface", "docComment": "/**\n * {@link Bezier} curve used for rendering canvas edge connections.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Bezier " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/Bezier.d.ts", "releaseTag": "Public", "name": "Bezier", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bezier#cp1:member", "docComment": "/**\n * First control point of the {@link Bezier} curve.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cp1: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "obsidian!Point:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cp1", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bezier#cp2:member", "docComment": "/**\n * Second control point of the {@link Bezier} curve.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cp2: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "obsidian!Point:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cp2", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bezier#from:member", "docComment": "/**\n * Start point of the {@link Bezier} curve.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "obsidian!Point:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bezier#path:member", "docComment": "/**\n * SVG path string representation of the {@link Bezier} curve.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bezier#to:member", "docComment": "/**\n * End point of the {@link Bezier} curve.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "obsidian!Point:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!BLEND_MODES:type", "docComment": "/**\n * Blend modes supported by PixiJS.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type BLEND_MODES = " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/BLEND_MODES.d.ts", "releaseTag": "Public", "name": "BLEND_MODES", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Bookmark:interface", "docComment": "/**\n * A bookmark marking a specific position in the editor document that tracks changes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Bookmark " } ], "fileUrlPath": "src/@codemirror__view/internals/Bookmark.d.ts", "releaseTag": "Public", "name": "Bookmark", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bookmark#assoc:member", "docComment": "/**\n * Association direction for the bookmark (-1 for left, 1 for right).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "assoc: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "assoc", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Bookmark#clear:member(1)", "docComment": "/**\n * Remove this bookmark from the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bookmark#cm:member", "docComment": "/**\n * The CodeMirror editor instance this bookmark belongs to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cm: " }, { "kind": "Reference", "text": "CodeMirrorEditor", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cm", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Bookmark#find:member(1)", "docComment": "/**\n * Find the current position of this bookmark, or null if cleared.\n *\n * @returns The current position, or null if the bookmark has been cleared.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "find(): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "find" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bookmark#id:member", "docComment": "/**\n * Unique identifier for this bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bookmark#offset:member", "docComment": "/**\n * Character offset of the bookmark within its line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Bookmark#update:member(1)", "docComment": "/**\n * Update the bookmark position in response to a document change.\n *\n * @param changeDesc - The change description to apply.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(changeDesc: " }, { "kind": "Reference", "text": "ChangeDesc", "canonicalReference": "obsidian-typings!~ChangeDesc" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "changeDesc", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "update" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BookmarkItem:interface", "docComment": "/**\n * A bookmark item in the bookmarks plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BookmarkItem " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/bookmark-items/BookmarkItem.d.ts", "releaseTag": "Public", "name": "BookmarkItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarkItem#ctime:member", "docComment": "/**\n * The creation time of the bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ctime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ctime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarkItem#items:member", "docComment": "/**\n * The items of the bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items?: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarkItem#path:member", "docComment": "/**\n * The path of the bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarkItem#query:member", "docComment": "/**\n * The query of the bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarkItem#subpath:member", "docComment": "/**\n * The subpath of the bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subpath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "subpath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarkItem#title:member", "docComment": "/**\n * The title of the bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarkItem#type:member", "docComment": "/**\n * The type of the bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'file' | 'folder' | 'graph' | 'group' | 'search' | 'url'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarkItem#url:member", "docComment": "/**\n * The URL of the bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BookmarksPlugin:interface", "docComment": "/**\n * Internal plugin registration for the bookmarks feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BookmarksPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BookmarksPluginInstance", "canonicalReference": "obsidian-typings!BookmarksPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/BookmarksPlugin.d.ts", "releaseTag": "Public", "name": "BookmarksPlugin", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPlugin#views:member", "docComment": "/**\n * View creators registered by the bookmarks plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "views: " }, { "kind": "Reference", "text": "BookmarksPluginViews", "canonicalReference": "obsidian-typings!BookmarksPluginViews:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "views", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BookmarksPluginInstance:interface", "docComment": "/**\n * Plugin instance for bookmarks, managing bookmarked files, folders, URLs, searches, and graphs.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BookmarksPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BookmarksPlugin", "canonicalReference": "obsidian-typings!BookmarksPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/BookmarksPluginInstance.d.ts", "releaseTag": "Public", "name": "BookmarksPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#_onItemsChanged:member(1)", "docComment": "/**\n * Internal handler called when bookmark items change.\n *\n * @param shouldSave - Whether to persist changes to storage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_onItemsChanged(shouldSave: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "shouldSave", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "_onItemsChanged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#addItem:member(1)", "docComment": "/**\n * Add a bookmark item, optionally to a specific parent instance.\n *\n * @param item - The bookmark item to add.\n *\n * @param instance - Optional parent plugin instance for group placement.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addItem(item: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": ", instance?: " }, { "kind": "Reference", "text": "BookmarksPluginInstance", "canonicalReference": "obsidian-typings!BookmarksPluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "instance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "addItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#bookmarkedViews:member", "docComment": "/**\n * Weak map tracking bookmarked views and their indicator elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bookmarkedViews: " }, { "kind": "Reference", "text": "WeakMap", "canonicalReference": "!WeakMap:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bookmarkedViews", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#bookmarkLookup:member", "docComment": "/**\n * Lookup table mapping paths to bookmark items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bookmarkLookup: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bookmarkLookup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#editItem:member(1)", "docComment": "/**\n * Open the edit dialog for a bookmark item.\n *\n * @param item - The bookmark item to edit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editItem(item: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "editItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#findBookmarkByView:member(1)", "docComment": "/**\n * Find the bookmark item associated with a given file view.\n *\n * @param view - The file view to find the bookmark for.\n *\n * @returns The matching bookmark item, or `null`/`undefined` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findBookmarkByView(view: " }, { "kind": "Reference", "text": "FileView", "canonicalReference": "obsidian!FileView:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": " | null | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "view", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "findBookmarkByView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#getBookmarks:member(1)", "docComment": "/**\n * Get a flat list of all bookmark items.\n *\n * @returns All bookmark items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBookmarks(): " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBookmarks" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#getItemTitle:member(1)", "docComment": "/**\n * Get the display title for a bookmark item.\n *\n * @param item - The bookmark item.\n *\n * @returns The display title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getItemTitle(item: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getItemTitle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#hasValidData:member", "docComment": "/**\n * Whether the bookmark data has been successfully loaded and validated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasValidData: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hasValidData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#initLeaf:member(1)", "docComment": "/**\n * Initialize the bookmarks view leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initLeaf(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initLeaf" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#items:member", "docComment": "/**\n * List of all bookmark items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#loadData:member(1)", "docComment": "/**\n * Load bookmark data from storage.\n *\n * @returns Whether the data was loaded successfully.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadData(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#moveItem:member(1)", "docComment": "/**\n * Move a bookmark item to a new position within the list.\n *\n * @param item - The bookmark item to move.\n *\n * @param instance - The target parent plugin instance, or `undefined` for root.\n *\n * @param index - The target index position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveItem(item: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": ", instance: " }, { "kind": "Reference", "text": "BookmarksPluginInstance", "canonicalReference": "obsidian-typings!BookmarksPluginInstance:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ", index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "instance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false } ], "name": "moveItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onEditorMenu:member(1)", "docComment": "/**\n * Add bookmark-related items to the editor context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param editor - The active editor.\n *\n * @param info - The active markdown view or file info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEditorMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", editor: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": ", info: " }, { "kind": "Reference", "text": "MarkdownFileInfo", "canonicalReference": "obsidian!MarkdownFileInfo:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MarkdownView", "canonicalReference": "obsidian!MarkdownView:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": false } ], "name": "onEditorMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onEnable:member(1)", "docComment": "/**\n * Called when the plugin is enabled.\n *\n * @param app - The app instance.\n *\n * @param plugin - The bookmarks plugin registration.\n *\n * @returns A promise that resolves when the plugin is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEnable(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", plugin: " }, { "kind": "Reference", "text": "BookmarksPlugin", "canonicalReference": "obsidian-typings!BookmarksPlugin:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "plugin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onEnable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Handle external settings file changes and reload configuration.\n *\n * @returns A promise that resolves when the settings are reloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onFileMenu:member(1)", "docComment": "/**\n * Add bookmark-related items to a file context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param files - The files for the context menu.\n *\n * @param source - The source of the context menu event.\n *\n * @param leaf - Optional workspace leaf context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", files: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", leaf?: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "files", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false }, { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "isOptional": true } ], "name": "onFileMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onFileRename:member(1)", "docComment": "/**\n * Handle a file rename and update affected bookmarks.\n *\n * @param file - The renamed file.\n *\n * @param oldPath - The previous file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileRename(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", oldPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "oldPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onFileRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onFilesMenu:member(1)", "docComment": "/**\n * Add bookmark-related items to a multi-file context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param files - The selected files.\n *\n * @param source - The source of the context menu event.\n *\n * @param leaf - Optional workspace leaf context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFilesMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", files: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", leaf?: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "files", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false }, { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "isOptional": true } ], "name": "onFilesMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onItemsChanged:member", "docComment": "/**\n * Debounced handler triggered when bookmark items change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onItemsChanged: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[boolean], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onItemsChanged", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onLeafMenu:member(1)", "docComment": "/**\n * Add bookmark-related items to a workspace leaf context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param leaf - The workspace leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onLeafMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onLeafMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onSearchResultsMenu:member(1)", "docComment": "/**\n * Add bookmark-related items to a search results context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param search - The search view workspace leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSearchResultsMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", search: " }, { "kind": "Reference", "text": "TypedWorkspaceLeaf", "canonicalReference": "obsidian-typings!TypedWorkspaceLeaf:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchView", "canonicalReference": "obsidian-typings!SearchView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "search", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": false } ], "name": "onSearchResultsMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onTabGroupMenu:member(1)", "docComment": "/**\n * Add bookmark-related items to a tab group context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param tabsLeaf - The workspace tabs container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTabGroupMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", tabsLeaf: " }, { "kind": "Reference", "text": "WorkspaceTabs", "canonicalReference": "obsidian!WorkspaceTabs:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "tabsLeaf", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onTabGroupMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#onUserEnable:member(1)", "docComment": "/**\n * Called when the user enables the plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onUserEnable(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onUserEnable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#openBookmark:member(1)", "docComment": "/**\n * Open a bookmark item in a new or existing leaf.\n *\n * @param item - The bookmark item to open.\n *\n * @param newLeaf - Where to open the bookmark.\n *\n * @param newLeaf2 - Optional secondary pane type.\n *\n * @returns A promise that resolves when the bookmark is opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openBookmark(item: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": ", newLeaf: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "PaneType", "canonicalReference": "obsidian!PaneType:type" }, { "kind": "Content", "text": ", newLeaf2?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "PaneType", "canonicalReference": "obsidian!PaneType:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newLeaf", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "newLeaf2", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "isOptional": true } ], "name": "openBookmark" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#openBookmarkInLeaf:member(1)", "docComment": "/**\n * Open a bookmark item in a specific workspace leaf.\n *\n * @param item - The bookmark item to open.\n *\n * @param leaf - The target workspace leaf.\n *\n * @param newLeaf - Optional pane type override.\n *\n * @returns A promise that resolves when the bookmark is opened in the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openBookmarkInLeaf(item: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": ", leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", newLeaf?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "PaneType", "canonicalReference": "obsidian!PaneType:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "newLeaf", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": true } ], "name": "openBookmarkInLeaf" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#openBookmarks:member(1)", "docComment": "/**\n * Open multiple bookmark items at once.\n *\n * @param items - The bookmark items to open.\n *\n * @param newLeaf - Optional pane type for opening.\n *\n * @returns A promise that resolves when all bookmarks are opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openBookmarks(items: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", newLeaf?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "PaneType", "canonicalReference": "obsidian!PaneType:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "items", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "newLeaf", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 }, "isOptional": true } ], "name": "openBookmarks" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#plugin:member", "docComment": "/**\n * Reference to the bookmarks plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "BookmarksPlugin", "canonicalReference": "obsidian-typings!BookmarksPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#rebuildBookmarkCache:member(1)", "docComment": "/**\n * Rebuild the internal bookmark lookup caches.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rebuildBookmarkCache(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "rebuildBookmarkCache" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#removeItem:member(1)", "docComment": "/**\n * Remove a bookmark item from the list.\n *\n * @param item - The bookmark item to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeItem(item: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#saveData:member(1)", "docComment": "/**\n * Persist the current bookmark data to storage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveData(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#updateTabHeaders:member(1)", "docComment": "/**\n * Update bookmark indicator icons on tab headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateTabHeaders(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateTabHeaders" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BookmarksPluginInstance#urlBookmarkLookup:member", "docComment": "/**\n * Lookup table mapping URLs to bookmark items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "urlBookmarkLookup: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "urlBookmarkLookup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BookmarksPluginViews:interface", "docComment": "/**\n * View creators registered by the bookmarks plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BookmarksPluginViews extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/BookmarksPluginViews.d.ts", "releaseTag": "Public", "name": "BookmarksPluginViews", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksPluginViews#bookmarks:member(1)", "docComment": "/**\n * Create a bookmarks view in the given workspace leaf.\n *\n * @param left - The workspace leaf to create the bookmarks view in.\n *\n * @returns The created bookmarks view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bookmarks(left: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BookmarksView", "canonicalReference": "obsidian-typings!BookmarksView:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "left", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "bookmarks" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BookmarksView:interface", "docComment": "/**\n * {@link obsidian#View} that displays the bookmarks sidebar, showing all bookmarked items in a tree.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BookmarksView extends " }, { "kind": "Reference", "text": "ItemView", "canonicalReference": "obsidian!ItemView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/BookmarksView.d.ts", "releaseTag": "Public", "name": "BookmarksView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#_copyToClipboard:member(1)", "docComment": "/**\n * Copy the selected bookmarks to the clipboard.\n *\n * @param e - The copy event or context.\n *\n * @param t - The target bookmark items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_copyToClipboard(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "_copyToClipboard" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#_getActiveBookmarks:member(1)", "docComment": "/**\n * Get the currently active/selected bookmark items.\n *\n * @returns The active bookmark items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_getActiveBookmarks(): " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "_getActiveBookmarks" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#attachDragHandler:member(1)", "docComment": "/**\n * Attaches the handleDrag of {@link DragManager}.\n *\n * @param e - The element to attach the drag handler to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attachDragHandler(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "attachDragHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#attachDropHandler:member(1)", "docComment": "/**\n * Attaches the handleDrop of {@link DragManager} to containerEl.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attachDropHandler(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "attachDropHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#constructor3__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param leaf - The workspace leaf.\n *\n * @param bookmarksPluginInstance - The bookmarks plugin instance.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor3__?(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", bookmarksPluginInstance: " }, { "kind": "Reference", "text": "BookmarksPluginInstance", "canonicalReference": "obsidian-typings!BookmarksPluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "bookmarksPluginInstance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor3__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#createNewGroup:member(1)", "docComment": "/**\n * Create a new bookmark group.\n *\n * @param e - The event or context for group creation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createNewGroup(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createNewGroup" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#dragSelectedBookmarks:member(1)", "docComment": "/**\n * Initiate a drag operation for the selected bookmarks.\n *\n * @param e - The drag event.\n *\n * @param t - The drag target information.\n *\n * @returns The drag data, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragSelectedBookmarks(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "dragSelectedBookmarks" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#getItemDom:member(1)", "docComment": "/**\n * Get the DOM element for a bookmark item.\n *\n * @param e - The bookmark item.\n *\n * @returns The DOM element for the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getItemDom(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getItemDom" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#getNodeId:member(1)", "docComment": "/**\n * Get the unique node identifier for a bookmark item.\n *\n * @param e - The bookmark item.\n *\n * @returns The node identifier string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNodeId(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getNodeId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The bookmarks view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Bookmarks", "canonicalReference": "obsidian-typings!~__type#Bookmarks:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#handleCollapseAll:member(1)", "docComment": "/**\n * Handle the collapse/expand all toggle action.\n *\n * @param e - Whether to collapse all.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleCollapseAll(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleCollapseAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#isItem:member(1)", "docComment": "/**\n * Check whether the given object is a bookmark item.\n *\n * @param item - The object to check.\n *\n * @returns Whether the object is a bookmark item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isItem(item: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#onContextMenu:member(1)", "docComment": "/**\n * Handle the context menu event on a bookmark item.\n *\n * @param event - The context menu event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onContextMenu(event: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onContextMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#onDeleteSelectedItems:member(1)", "docComment": "/**\n * Called when delete is requested.\n *\n * @param event - The event triggered this function.\n *\n * @returns The result of the delete operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDeleteSelectedItems(event: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDeleteSelectedItems" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#onFileCreate:member(1)", "docComment": "/**\n * Called when a file is created.\n *\n * @param file - The created file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileCreate(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileCreate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#onFileDelete:member(1)", "docComment": "/**\n * Called when a file is deleted.\n *\n * @param file - The deleted file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileDelete(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileDelete" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#onFileOpen:member(1)", "docComment": "/**\n * Handle a file being opened and highlight corresponding bookmark.\n *\n * @param file - The opened file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileOpen(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#onRenameKey:member(1)", "docComment": "/**\n * Called when the rename shortcut is pressed.\n *\n * @param event - The event triggered this function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRenameKey(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onRenameKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!BookmarksView#update:member(1)", "docComment": "/**\n * Refresh the bookmarks view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Bracket:interface", "docComment": "/**\n * Represents a bracket character found at a specific position in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Bracket " } ], "fileUrlPath": "src/@codemirror__view/internals/Bracket.d.ts", "releaseTag": "Public", "name": "Bracket", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bracket#ch:member", "docComment": "/**\n * The bracket character.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ch: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Bracket#pos:member", "docComment": "/**\n * Position of the bracket in the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pos", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions:interface", "docComment": "/**\n * Options for creating a new BrowserWindow.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BrowserWindowConstructorOptions " } ], "fileUrlPath": "src/electron/internals/BrowserWindowConstructorOptions.d.ts", "releaseTag": "Public", "name": "BrowserWindowConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#acceptFirstMouse:member", "docComment": "/**\n * Whether clicking an inactive window will also click through to the web contents. This option is not configurable on platforms other than macOS.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "acceptFirstMouse?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "acceptFirstMouse", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#alwaysOnTop:member", "docComment": "/**\n * Whether the window should always stay on top of other windows.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alwaysOnTop?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "alwaysOnTop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#autoHideMenuBar:member", "docComment": "/**\n * Auto hide the menu bar unless the `Alt` key is pressed.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoHideMenuBar?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autoHideMenuBar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#backgroundColor:member", "docComment": "/**\n * The window's background color in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. Alpha in `#AARRGGBB` format is supported if `transparent` is set to `true`.\n *\n * @default\n *\n * `#FFF`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundColor?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "backgroundColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#center:member", "docComment": "/**\n * Show window in the center of the screen.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "center?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "center", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#closable:member", "docComment": "/**\n * Whether window is closable. This is not implemented on Linux.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "closable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#darkTheme:member", "docComment": "/**\n * Forces using dark theme for the window, only works on some GTK+3 desktop environments.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "darkTheme?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "darkTheme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#disableAutoHideCursor:member", "docComment": "/**\n * Whether to hide cursor when typing.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableAutoHideCursor?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableAutoHideCursor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#enableLargerThanScreen:member", "docComment": "/**\n * Enable the window to be resized larger than screen. Only relevant for macOS, as other OSes allow larger-than-screen windows by default.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableLargerThanScreen?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enableLargerThanScreen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#focusable:member", "docComment": "/**\n * Whether the window can be focused. On Windows setting `focusable: false` also implies setting `skipTaskbar: true`. On Linux setting `focusable: false` makes the window stop interacting with wm.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "focusable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#frame:member", "docComment": "/**\n * Specify `false` to create a frameless window.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#fullscreen:member", "docComment": "/**\n * Whether the window should show in fullscreen. When explicitly set to `false` the fullscreen button will be hidden or disabled on macOS.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fullscreen?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fullscreen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#fullscreenable:member", "docComment": "/**\n * Whether the window can be put into fullscreen mode. On macOS, also whether the maximize/zoom button should toggle full screen mode or maximize window.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fullscreenable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fullscreenable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#fullscreenWindowTitle:member", "docComment": "/**\n * Shows the title in the title bar in full screen mode on macOS for `hiddenInset` titleBarStyle.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fullscreenWindowTitle?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fullscreenWindowTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#hasShadow:member", "docComment": "/**\n * Whether window should have a shadow.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasShadow?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hasShadow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#height:member", "docComment": "/**\n * Window's height in pixels.\n *\n * @default\n *\n * `600`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#icon:member", "docComment": "/**\n * The window icon. On Windows it is recommended to use `ICO` icons to get best visual effects; it can also be left undefined so the executable's icon will be used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#kiosk:member", "docComment": "/**\n * Whether the window is in kiosk mode.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "kiosk?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "kiosk", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#maxHeight:member", "docComment": "/**\n * Window's maximum height. Default is no limit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxHeight?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#maximizable:member", "docComment": "/**\n * Whether window is maximizable. This is not implemented on Linux.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maximizable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maximizable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#maxWidth:member", "docComment": "/**\n * Window's maximum width. Default is no limit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxWidth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#minHeight:member", "docComment": "/**\n * Window's minimum height.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minHeight?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "minHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#minimizable:member", "docComment": "/**\n * Whether window is minimizable. This is not implemented on Linux.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minimizable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "minimizable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#minWidth:member", "docComment": "/**\n * Window's minimum width.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minWidth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "minWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#modal:member", "docComment": "/**\n * Whether this is a modal window. This only works when the window is a child window.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modal?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "modal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#movable:member", "docComment": "/**\n * Whether window is movable. This is not implemented on Linux.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "movable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "movable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#opacity:member", "docComment": "/**\n * Set the initial opacity of the window, between `0.0` (fully transparent) and `1.0` (fully opaque). This is only implemented on Windows and macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "opacity?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "opacity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#paintWhenInitiallyHidden:member", "docComment": "/**\n * Whether the renderer should be active when `show` is `false` and it has just been created. In order for `document.visibilityState` to work correctly on first load with `show: false` this should be set to `false`.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paintWhenInitiallyHidden?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "paintWhenInitiallyHidden", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#parent:member", "docComment": "/**\n * Specify parent window.\n *\n * @default\n *\n * `null`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent?: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#resizable:member", "docComment": "/**\n * Whether window is resizable.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resizable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "resizable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#roundedCorners:member", "docComment": "/**\n * Whether frameless window should have rounded corners on macOS.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "roundedCorners?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "roundedCorners", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#show:member", "docComment": "/**\n * Whether window should be shown when created.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "show?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "show", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#simpleFullscreen:member", "docComment": "/**\n * Use pre-Lion fullscreen on macOS.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "simpleFullscreen?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "simpleFullscreen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#skipTaskbar:member", "docComment": "/**\n * Whether to show the window in taskbar.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skipTaskbar?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "skipTaskbar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#tabbingIdentifier:member", "docComment": "/**\n * Tab group name, allows opening the window as a native tab on macOS 10.12+. Windows with the same tabbing identifier will be grouped together.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabbingIdentifier?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tabbingIdentifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#thickFrame:member", "docComment": "/**\n * Use `WS_THICKFRAME` style for frameless windows on Windows, which adds standard window frame. Setting it to `false` will remove window shadow and window animations.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "thickFrame?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "thickFrame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#title:member", "docComment": "/**\n * Default window title. If the HTML tag `` is defined in the HTML file loaded by `loadURL()`, this property will be ignored.\n *\n * @default\n *\n * `Electron`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#titleBarOverlay:member", "docComment": "/**\n * When using a frameless window in conjunction with `win.setWindowButtonVisibility(true)` on macOS or using a `titleBarStyle` so that the standard window controls are visible, this property enables the Window Controls Overlay JavaScript APIs and CSS Environment Variables. Specifying `true` will result in an overlay with default system colors.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "titleBarOverlay?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "ElectronTitleBarOverlay", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlay:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "titleBarOverlay", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#titleBarStyle:member", "docComment": "/**\n * The style of window title bar (macOS and Windows).\n *\n * @default\n *\n * `default`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "titleBarStyle?: " }, { "kind": "Content", "text": "'customButtonsOnHover' | 'default' | 'hidden' | 'hiddenInset'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "titleBarStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#trafficLightPosition:member", "docComment": "/**\n * Set a custom position for the traffic light buttons in frameless windows.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trafficLightPosition?: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "trafficLightPosition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#transparent:member", "docComment": "/**\n * Makes the window transparent. On Windows, does not work unless the window is frameless.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transparent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "transparent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#type:member", "docComment": "/**\n * The type of window, default is normal window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#useContentSize:member", "docComment": "/**\n * The `width` and `height` would be used as web page's size, which means the actual window's size will include window frame's size and be slightly larger.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useContentSize?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "useContentSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#vibrancy:member", "docComment": "/**\n * Add a type of vibrancy effect to the window, only on macOS. Note that `appearance-based`, `light`, `dark`, `medium-light`, and `ultra-dark` are deprecated and have been removed in macOS Catalina (10.15).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vibrancy?: " }, { "kind": "Content", "text": "'appearance-based' | 'content' | 'dark' | 'fullscreen-ui' | 'header' | 'hud' | 'light' | 'medium-light' | 'menu' | 'popover' | 'selection' | 'sheet' | 'sidebar' | 'titlebar' | 'tooltip' | 'ultra-dark' | 'under-page' | 'under-window' | 'window'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "vibrancy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#visualEffectState:member", "docComment": "/**\n * Specify how the material appearance should reflect window activity state on macOS. Must be used with the `vibrancy` property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "visualEffectState?: " }, { "kind": "Content", "text": "'active' | 'followWindow' | 'inactive'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "visualEffectState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#webPreferences:member", "docComment": "/**\n * Settings of web page's features.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webPreferences?: " }, { "kind": "Reference", "text": "WebPreferences", "canonicalReference": "obsidian-typings!WebPreferences:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webPreferences", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#width:member", "docComment": "/**\n * Window's width in pixels.\n *\n * @default\n *\n * `800`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#x:member", "docComment": "/**\n * Window's left offset from screen (required if `y` is used). Default is to center the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#y:member", "docComment": "/**\n * Window's top offset from screen (required if `x` is used). Default is to center the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions#zoomToPageWidth:member", "docComment": "/**\n * Controls the behavior on macOS when option-clicking the green stoplight button on the toolbar or by clicking the Window \\> Zoom menu item. If `true`, the window will grow to the preferred width of the web page when zoomed, `false` will cause it to zoom to the width of the screen.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomToPageWidth?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "zoomToPageWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Btime:interface", "docComment": "/**\n * Interface for setting the birth time (creation time) of a file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Btime " } ], "fileUrlPath": "src/obsidian/internals/Btime.d.ts", "releaseTag": "Public", "name": "Btime", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Btime#btime:member(1)", "docComment": "/**\n * Set the birth time (creation time) of a file at the given path.\n *\n * @param path - File path.\n *\n * @param btime - Birth time in milliseconds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "btime(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", btime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "btime", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "btime" } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!build:var", "docComment": "/**\n * The build identifier of the PDF.js library.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "build: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/pdfjs-dist/internals/vars/build.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "build", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!Callback:type", "docComment": "/**\n * Callback type for i18next operations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Callback = " }, { "kind": "Content", "text": "(error: unknown, t: " }, { "kind": "Reference", "text": "TFunction", "canonicalReference": "obsidian-typings!TFunction:type" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/i18next/internals/Callback.d.ts", "releaseTag": "Public", "name": "Callback", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasConnection:interface", "docComment": "/**\n * Represents a connection (edge) between two nodes on a canvas.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasConnection " } ], "fileUrlPath": "src/obsidian/internals/CanvasConnection.d.ts", "releaseTag": "Public", "name": "CanvasConnection", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasDataManager:interface", "docComment": "/**\n * Manages saving, loading, and maintaining canvas local data on disk.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasDataManager " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasDataManager.d.ts", "releaseTag": "Public", "name": "CanvasDataManager", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasDataManager#app:member", "docComment": "/**\n * Reference to the Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasDataManager#handleDelete:member(1)", "docComment": "/**\n * Handle a file deletion event and remove associated canvas data.\n *\n * @returns The result of handling the deletion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDelete(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleDelete" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasDataManager#handleRename:member(1)", "docComment": "/**\n * Handle a file rename event and update associated canvas data paths.\n *\n * @returns The result of handling the rename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleRename(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "handleRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasDataManager#load:member(1)", "docComment": "/**\n * Load canvas data for the specified file.\n *\n * @returns The loaded canvas data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "load(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "load" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasDataManager#remove:member(1)", "docComment": "/**\n * Remove stored canvas data for the specified file.\n *\n * @returns The result of removing the data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "remove" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasDataManager#save:member(1)", "docComment": "/**\n * Save canvas data for the specified file.\n *\n * @returns The result of saving the data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "save(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "save" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasEmbed:interface", "docComment": "/**\n * Represents an embedded file reference within a canvas node.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasEmbed " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasEmbed.d.ts", "releaseTag": "Public", "name": "CanvasEmbed", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasEmbed#file:member", "docComment": "/**\n * Path to the embedded file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasEmbed#subpath:member", "docComment": "/**\n * Optional subpath within the file (e.g., heading or block reference).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subpath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "subpath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasIndex:interface", "docComment": "/**\n * Index that tracks and resolves links, embeds, and metadata across all canvas files.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasIndex extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasIndex.d.ts", "releaseTag": "Public", "name": "CanvasIndex", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasIndex#app:member", "docComment": "/**\n * Reference to the Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#canProcess:member(1)", "docComment": "/**\n * Check whether a file can be processed by the canvas indexer.\n *\n * @returns Whether the file can be processed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canProcess(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "canProcess" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasIndex#fileQueue:member", "docComment": "/**\n * Queue of files waiting to be processed by the indexer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fileQueue: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fileQueue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasIndex#frame:member", "docComment": "/**\n * Current animation frame request, or `null` when idle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#get:member(1)", "docComment": "/**\n * Get the index entry for the specified file.\n *\n * @returns The index entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#getAll:member(1)", "docComment": "/**\n * Get all index entries.\n *\n * @returns All index entries.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAll(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#getForPath:member(1)", "docComment": "/**\n * Get the index entry for the specified file path.\n *\n * @returns The index entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getForPath(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getForPath" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasIndex#index:member", "docComment": "/**\n * Index of canvas entries keyed by file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "index: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CanvasIndexEntry", "canonicalReference": "obsidian-typings!CanvasIndexEntry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "index", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#onCreate:member(1)", "docComment": "/**\n * Handle a file creation event.\n *\n * @returns The result of handling the creation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCreate(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onCreate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#onDelete:member(1)", "docComment": "/**\n * Handle a file deletion event.\n *\n * @returns The result of handling the deletion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDelete(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDelete" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#onload:member(1)", "docComment": "/**\n * Initialize the index when the component loads.\n *\n * @returns The result of loading the index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onload(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#onModify:member(1)", "docComment": "/**\n * Handle a file modification event.\n *\n * @returns The result of handling the modification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onModify(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onModify" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#onRename:member(1)", "docComment": "/**\n * Handle a file rename event.\n *\n * @returns The result of handling the rename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRename(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#onunload:member(1)", "docComment": "/**\n * Clean up the index when the component unloads.\n *\n * @returns The result of unloading the index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onunload(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onunload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#parseText:member(1)", "docComment": "/**\n * Parse canvas text content and extract metadata.\n *\n * @returns The parsed metadata.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parseText(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "parseText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#process:member(1)", "docComment": "/**\n * Process a single canvas file and update the index.\n *\n * @returns The result of processing the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "process(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "process" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#queue:member(1)", "docComment": "/**\n * Add a file to the processing queue.\n *\n * @returns The result of queuing the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queue(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "queue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasIndex#refNodeIds:member", "docComment": "/**\n * Weak map tracking reference node IDs for canvas files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "refNodeIds: " }, { "kind": "Reference", "text": "WeakMap", "canonicalReference": "!WeakMap:interface" }, { "kind": "Content", "text": "<object, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "refNodeIds", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#requestFrame:member(1)", "docComment": "/**\n * Request an animation frame to process queued files.\n *\n * @returns The result of requesting the frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestFrame(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "requestFrame" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasIndex#run:member(1)", "docComment": "/**\n * Run the indexer to process all queued files.\n *\n * @returns The result of running the indexer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "run(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "run" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasIndexEntry:interface", "docComment": "/**\n * Represents a single entry in the canvas index, containing cached metadata and embeds for a canvas file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasIndexEntry " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasIndexEntry.d.ts", "releaseTag": "Public", "name": "CanvasIndexEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasIndexEntry#caches:member", "docComment": "/**\n * Cached metadata for each node in the canvas, keyed by node ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "caches: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CachedMetadata", "canonicalReference": "obsidian!CachedMetadata:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "caches", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasIndexEntry#embeds:member", "docComment": "/**\n * List of embedded file references within the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "embeds: " }, { "kind": "Reference", "text": "CanvasEmbed", "canonicalReference": "obsidian-typings!CanvasEmbed:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "embeds", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasLinkUpdater:interface", "docComment": "/**\n * Link updater for canvas files, handling link updates when files are renamed or moved.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasLinkUpdater extends " }, { "kind": "Reference", "text": "LinkUpdater", "canonicalReference": "obsidian-typings!LinkUpdater:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/link-update/CanvasLinkUpdater.d.ts", "releaseTag": "Public", "name": "CanvasLinkUpdater", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasLinkUpdater#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasLinkUpdater#canvas:member", "docComment": "/**\n * Canvas plugin instance used to access canvas data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas: " }, { "kind": "Reference", "text": "CanvasPluginInstance", "canonicalReference": "obsidian-typings!CanvasPluginInstance:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasMenu:interface", "docComment": "/**\n * Context menu and toolbar displayed on the canvas for node/edge actions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasMenu " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasMenu.d.ts", "releaseTag": "Public", "name": "CanvasMenu", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasMenu#canvas:member", "docComment": "/**\n * Reference to the parent canvas instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas: " }, { "kind": "Reference", "text": "CanvasViewCanvas", "canonicalReference": "obsidian-typings!CanvasViewCanvas:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasMenu#containerEl:member", "docComment": "/**\n * Outer container element for the menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasMenu#menuEl:member", "docComment": "/**\n * Element containing the menu buttons and controls.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "menuEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "menuEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasMenu#render:member(1)", "docComment": "/**\n * Render the menu for the given selection or context.\n *\n * @returns The result of rendering the menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasMenu#selection:member", "docComment": "/**\n * Reference to the current canvas selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selection: " }, { "kind": "Reference", "text": "CanvasSelection", "canonicalReference": "obsidian-typings!CanvasSelection:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasMenu#updateZIndex:member(1)", "docComment": "/**\n * Update the menu's z-index to stay above the selected items.\n *\n * @returns The result of updating the z-index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateZIndex(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateZIndex" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasNode:interface", "docComment": "/**\n * Represents a node (card) on a canvas.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasNode " } ], "fileUrlPath": "src/obsidian/internals/CanvasNode.d.ts", "releaseTag": "Public", "name": "CanvasNode", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasPlugin:interface", "docComment": "/**\n * Internal plugin definition for the Canvas feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CanvasPluginInstance", "canonicalReference": "obsidian-typings!CanvasPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasPlugin.d.ts", "releaseTag": "Public", "name": "CanvasPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasPluginInstance:interface", "docComment": "/**\n * Plugin instance for the Canvas internal plugin, managing canvas indexing, data, and rename operations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CanvasPlugin", "canonicalReference": "obsidian-typings!CanvasPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasPluginInstance.d.ts", "releaseTag": "Public", "name": "CanvasPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#app:member", "docComment": "/**\n * Reference to the Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#createNewCanvasFile:member(1)", "docComment": "/**\n * Creates a new canvas file.\n *\n * @param location - The parent folder. Defaults to the configured new-file location.\n *\n * @param filename - The file name (without extension).\n *\n * @param contents - The initial file contents.\n *\n * @returns A promise resolving to the created file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createNewCanvasFile(location?: " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": ", filename?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", contents?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "location", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "filename", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "contents", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "createNewCanvasFile" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#getNewFileParent:member(1)", "docComment": "/**\n * Gets the folder a new canvas file should be created in.\n *\n * @param sourcePath - The path of the current file.\n *\n * @param newFilePath - The path of the file being created.\n *\n * @returns The destination folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNewFileParent(sourcePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", newFilePath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "sourcePath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newFilePath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getNewFileParent" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#index:member", "docComment": "/**\n * Index for resolving links and embeds within canvas files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "index: " }, { "kind": "Reference", "text": "CanvasIndex", "canonicalReference": "obsidian-typings!CanvasIndex:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "index", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#localDataManager:member", "docComment": "/**\n * Manager for loading, saving, and handling canvas local data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "localDataManager: " }, { "kind": "Reference", "text": "CanvasDataManager", "canonicalReference": "obsidian-typings!CanvasDataManager:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "localDataManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#onDelete:member(1)", "docComment": "/**\n * Handles deletion of a canvas file.\n *\n * @param file - The deleted file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDelete(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDelete" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Handles a settings change made externally (e.g. by Sync).\n *\n * @returns A promise that resolves when the change has been handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#onFileMenu:member(1)", "docComment": "/**\n * Adds canvas-related items to the file context menu.\n *\n * @param menu - The menu to add to.\n *\n * @param file - The file or folder the menu was opened on.\n *\n * @param source - The source of the menu (e.g. `'file-explorer-context-menu'`).\n *\n * @param leaf - The leaf the menu was opened from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", leaf?: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "onFileMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#onRename:member(1)", "docComment": "/**\n * Handles renaming of a canvas file.\n *\n * @param file - The renamed file.\n *\n * @param oldPath - The previous path of the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRename(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", oldPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "oldPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onRename" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#options:member", "docComment": "/**\n * User-configurable options for the canvas plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "CanvasPluginInstanceOptions", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#plugin:member", "docComment": "/**\n * Reference to the parent canvas plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "CanvasPlugin", "canonicalReference": "obsidian-typings!CanvasPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#renameQueue:member", "docComment": "/**\n * Queue for processing file rename operations sequentially.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renameQueue: " }, { "kind": "Reference", "text": "PromisedQueue", "canonicalReference": "obsidian-typings!PromisedQueue:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renameQueue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#renames:member", "docComment": "/**\n * Pending rename operations to be processed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renames: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renames", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#requestProcessRename:member", "docComment": "/**\n * Debounced function to process pending rename operations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestProcessRename: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestProcessRename", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#rerenderCanvases:member(1)", "docComment": "/**\n * Re-renders all open canvas views.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rerenderCanvases(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "rerenderCanvases" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasPluginInstance#saveOptions:member(1)", "docComment": "/**\n * Persists the plugin's options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveOptions(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveOptions" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions:interface", "docComment": "/**\n * User-configurable options for the Canvas plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasPluginInstanceOptions " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasPluginInstanceOptions.d.ts", "releaseTag": "Public", "name": "CanvasPluginInstanceOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions#cardLabelVisibility:member", "docComment": "/**\n * When to display card labels: always, on hover, or never.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cardLabelVisibility?: " }, { "kind": "Content", "text": "'always' | 'hover' | 'never'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cardLabelVisibility", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions#defaultModDragBehavior:member", "docComment": "/**\n * Default node type created when modifier-dragging onto the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultModDragBehavior?: " }, { "kind": "Content", "text": "'card' | 'group' | 'media' | 'menu' | 'note' | 'webpage'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultModDragBehavior", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions#defaultWheelBehavior:member", "docComment": "/**\n * Default mouse wheel behavior: pan or zoom.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultWheelBehavior?: " }, { "kind": "Content", "text": "'pan' | 'zoom'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultWheelBehavior", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions#newFileFolderPath:member", "docComment": "/**\n * Folder path for newly created files from the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newFileFolderPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "newFileFolderPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions#newFileLocation:member", "docComment": "/**\n * Where to create new files: vault root, current folder, or a specified folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newFileLocation?: " }, { "kind": "Content", "text": "'current' | 'folder' | 'root'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "newFileLocation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions#snapToGrid:member", "docComment": "/**\n * Whether nodes snap to the grid when moved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "snapToGrid?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "snapToGrid", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions#snapToObjects:member", "docComment": "/**\n * Whether nodes snap to other objects when moved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "snapToObjects?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "snapToObjects", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasPluginInstanceOptions#zoomBreakpoint:member", "docComment": "/**\n * Zoom level threshold for switching rendering detail levels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomBreakpoint?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "zoomBreakpoint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasRectEx:interface", "docComment": "/**\n * Extended rectangle representation for the canvas, providing both min/max and position/size properties.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasRectEx " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasRectEx.d.ts", "releaseTag": "Public", "name": "CanvasRectEx", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#cx:member", "docComment": "/**\n * Center X coordinate of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cx: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#cy:member", "docComment": "/**\n * Center Y coordinate of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cy: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#height:member", "docComment": "/**\n * Height of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#left:member", "docComment": "/**\n * Left edge X coordinate of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#maxX:member", "docComment": "/**\n * Maximum X coordinate (right edge).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "maxX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#maxY:member", "docComment": "/**\n * Maximum Y coordinate (bottom edge).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "maxY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#minX:member", "docComment": "/**\n * Minimum X coordinate (left edge).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#minY:member", "docComment": "/**\n * Minimum Y coordinate (top edge).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#top:member", "docComment": "/**\n * Top edge Y coordinate of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasRectEx#width:member", "docComment": "/**\n * Width of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasSelection:interface", "docComment": "/**\n * Manages the visual selection state on the canvas, including selection bounds and resize handles.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasSelection " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasSelection.d.ts", "releaseTag": "Public", "name": "CanvasSelection", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasSelection#bbox:member", "docComment": "/**\n * Bounding box encompassing all selected items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bbox: " }, { "kind": "Reference", "text": "BBox", "canonicalReference": "obsidian-typings!BBox:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bbox", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasSelection#canvas:member", "docComment": "/**\n * Reference to the parent canvas instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas: " }, { "kind": "Reference", "text": "CanvasViewCanvas", "canonicalReference": "obsidian-typings!CanvasViewCanvas:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasSelection#hide:member(1)", "docComment": "/**\n * Hide the selection rectangle and handles.\n *\n * @returns The result of hiding the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hide(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hide" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasSelection#onResizePointerdown:member(1)", "docComment": "/**\n * Handle pointer down on a resize handle to start resizing the selection.\n *\n * @returns The result of handling the resize pointer down.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResizePointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onResizePointerdown" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasSelection#resizerEls:member", "docComment": "/**\n * Array of resize handle elements around the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resizerEls: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resizerEls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasSelection#selectionEl:member", "docComment": "/**\n * Element displaying the selection highlight rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectionEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectionEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasSelection#update:member(1)", "docComment": "/**\n * Update the selection rectangle to match the current selected items.\n *\n * @returns The result of updating the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "update" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasView:interface", "docComment": "/**\n * View for displaying and editing canvas files, extending {@link obsidian#TextFileView}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasView extends " }, { "kind": "Reference", "text": "TextFileView", "canonicalReference": "obsidian!TextFileView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasView.d.ts", "releaseTag": "Public", "name": "CanvasView", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasView#canvas:member", "docComment": "/**\n * The canvas controller instance managing nodes, edges, and rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas: " }, { "kind": "Reference", "text": "CanvasViewCanvas", "canonicalReference": "obsidian-typings!CanvasViewCanvas:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasView#constructor4__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param leaf - The workspace leaf.\n *\n * @param canvasPluginInstance - The canvas plugin instance.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor4__?(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", canvasPluginInstance: " }, { "kind": "Reference", "text": "CanvasPluginInstance", "canonicalReference": "obsidian-typings!CanvasPluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "canvasPluginInstance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor4__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasView#getLocalData:member(1)", "docComment": "/**\n * Loads the local data of the canvas.\n *\n * @returns The local canvas data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLocalData(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLocalData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Canvas", "canonicalReference": "obsidian-typings!~__type#Canvas:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasView#hoverPopover:member", "docComment": "/**\n * Hover popover associated with this view, or `null` if none is active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverPopover: " }, { "kind": "Reference", "text": "HoverPopover", "canonicalReference": "obsidian!HoverPopover:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverPopover", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasView#plugin:member", "docComment": "/**\n * Reference to the canvas plugin instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "CanvasPluginInstance", "canonicalReference": "obsidian-typings!CanvasPluginInstance:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasView#saveLocalData:member(1)", "docComment": "/**\n * Saves the local data of the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveLocalData(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveLocalData" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvas:interface", "docComment": "/**\n * Main canvas controller that manages rendering, selection, drag, zoom, pan, nodes, and edges for the canvas view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvas " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvas.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvas", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#addEdge:member(1)", "docComment": "/**\n * Add an edge to the canvas.\n *\n * @returns The added edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addEdge(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addEdge" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#addNode:member(1)", "docComment": "/**\n * Add a node to the canvas.\n *\n * @returns The added node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addNode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#app:member", "docComment": "/**\n * Reference to the Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#applyHistory:member(1)", "docComment": "/**\n * Apply a history state to restore the canvas to a previous state.\n *\n * @returns The result of applying the history state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applyHistory(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "applyHistory" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#backgroundPatternEl:member", "docComment": "/**\n * SVG pattern element used for rendering the canvas background grid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundPatternEl: " }, { "kind": "Reference", "text": "SVGPatternElement", "canonicalReference": "!SVGPatternElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backgroundPatternEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#cancelFrame:member(1)", "docComment": "/**\n * Cancel the current pending animation frame.\n *\n * @returns The result of canceling the frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancelFrame(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cancelFrame" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#canSnap:member(1)", "docComment": "/**\n * Check whether snapping is currently possible for the given context.\n *\n * @returns Whether snapping is possible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canSnap(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "canSnap" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#canvasControlsEl:member", "docComment": "/**\n * Container element for canvas control buttons (zoom, undo/redo, etc.).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvasControlsEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvasControlsEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#canvasEl:member", "docComment": "/**\n * Main canvas container element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvasEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvasEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#canvasRect:member", "docComment": "/**\n * Extended rectangle representing the canvas bounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvasRect: " }, { "kind": "Reference", "text": "CanvasRectEx", "canonicalReference": "obsidian-typings!CanvasRectEx:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvasRect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#cardMenuEl:member", "docComment": "/**\n * Container element for the card creation menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cardMenuEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cardMenuEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#clear:member(1)", "docComment": "/**\n * Remove all nodes and edges from the canvas.\n *\n * @returns The result of clearing the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#clearSnapPoints:member(1)", "docComment": "/**\n * Clear all active snap point guides.\n *\n * @returns The result of clearing snap points.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearSnapPoints(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearSnapPoints" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#cloneData:member(1)", "docComment": "/**\n * Clone canvas data, creating duplicates of the specified items at the given offset.\n *\n * @returns The cloned canvas data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cloneData(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "cloneData" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#config:member", "docComment": "/**\n * Configuration settings for the canvas view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "config: " }, { "kind": "Reference", "text": "CanvasViewConfig", "canonicalReference": "obsidian-typings!CanvasViewConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "config", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#createFileNode:member(1)", "docComment": "/**\n * Create a new file-type node on the canvas.\n *\n * @returns The created file node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFileNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createFileNode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#createFileNodes:member(1)", "docComment": "/**\n * Create multiple file-type nodes on the canvas.\n *\n * @returns The created file nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFileNodes(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "createFileNodes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#createGroupNode:member(1)", "docComment": "/**\n * Create a new group node on the canvas.\n *\n * @returns The created group node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createGroupNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createGroupNode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#createLinkNode:member(1)", "docComment": "/**\n * Create a new link/URL node on the canvas.\n *\n * @returns The created link node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createLinkNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createLinkNode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#createPlaceholder:member(1)", "docComment": "/**\n * Create a placeholder node for drag-and-drop operations.\n *\n * @returns The created placeholder node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createPlaceholder(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "createPlaceholder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#createTextNode:member(1)", "docComment": "/**\n * Create a new text node on the canvas.\n *\n * @returns The created text node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createTextNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createTextNode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#data:member", "docComment": "/**\n * Serialized canvas data containing nodes and edges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "CanvasViewData", "canonicalReference": "obsidian-typings!CanvasViewData:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#deleteSelection:member(1)", "docComment": "/**\n * Delete all currently selected nodes and edges.\n *\n * @returns The result of deleting the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deleteSelection(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "deleteSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#deselect:member(1)", "docComment": "/**\n * Remove an item from the current selection.\n *\n * @returns The result of deselecting the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deselect(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "deselect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#deselectAll:member(1)", "docComment": "/**\n * Clear the entire selection.\n *\n * @returns The result of clearing the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deselectAll(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "deselectAll" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#dirty:member", "docComment": "/**\n * Set of items that have been modified and need saving.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dirty: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dirty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#domFromPos:member(1)", "docComment": "/**\n * Convert a canvas position to DOM pixel coordinates.\n *\n * @returns The DOM pixel coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "domFromPos(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "domFromPos" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#domPosFromClient:member(1)", "docComment": "/**\n * Convert client (screen) coordinates to DOM pixel coordinates.\n *\n * @returns The DOM pixel coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "domPosFromClient(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "domPosFromClient" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#domPosFromEvt:member(1)", "docComment": "/**\n * Convert a DOM event's position to DOM pixel coordinates.\n *\n * @returns The DOM pixel coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "domPosFromEvt(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "domPosFromEvt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#dragTempNode:member(1)", "docComment": "/**\n * Handle dragging a temporary node during creation.\n *\n * @returns The result of dragging the temporary node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragTempNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "dragTempNode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#edgeContainerEl:member", "docComment": "/**\n * SVG container element for edge lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "edgeContainerEl: " }, { "kind": "Reference", "text": "SVGElement", "canonicalReference": "!SVGElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "edgeContainerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#edgeEndContainerEl:member", "docComment": "/**\n * SVG container element for edge endpoint markers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "edgeEndContainerEl: " }, { "kind": "Reference", "text": "SVGElement", "canonicalReference": "!SVGElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "edgeEndContainerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#edgeFrom:member", "docComment": "/**\n * Mapping of edges to their source nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "edgeFrom: " }, { "kind": "Reference", "text": "MapOfSets", "canonicalReference": "obsidian-typings!MapOfSets:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CanvasViewCanvasEdge", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "CanvasViewCanvasNode", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "edgeFrom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#edgeIndex:member", "docComment": "/**\n * Spatial index (R-tree) for efficient edge hit-testing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "edgeIndex: " }, { "kind": "Reference", "text": "EdgeIndex", "canonicalReference": "obsidian-typings!EdgeIndex:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "edgeIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#edges:member", "docComment": "/**\n * Map of all edges on the canvas, keyed by edge ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "edges: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CanvasViewCanvasEdge", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "edges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#edgeTo:member", "docComment": "/**\n * Mapping of edges to their target nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "edgeTo: " }, { "kind": "Reference", "text": "MapOfSets", "canonicalReference": "obsidian-typings!MapOfSets:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CanvasViewCanvasEdge", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "CanvasViewCanvasNode", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "edgeTo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#endSnapPointRendering:member(1)", "docComment": "/**\n * Stop rendering snap point guide lines.\n *\n * @returns The result of ending snap point rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "endSnapPointRendering(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "endSnapPointRendering" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#finishViewportAnimation:member", "docComment": "/**\n * Whether to finish the current viewport animation on the next frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "finishViewportAnimation: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "finishViewportAnimation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#frame:member", "docComment": "/**\n * Current animation frame request ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#frameWin:member", "docComment": "/**\n * Animation frame window reference, null when not animating.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frameWin: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frameWin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#generateHDImage:member(1)", "docComment": "/**\n * Generate a high-definition image of the canvas.\n *\n * @returns The generated HD image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "generateHDImage(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "generateHDImage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getContainingNodes:member(1)", "docComment": "/**\n * Get all nodes that contain the specified bounding box or point.\n *\n * @returns The containing nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getContainingNodes(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getContainingNodes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getData:member(1)", "docComment": "/**\n * Get the serialized canvas data.\n *\n * @returns The canvas data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getData(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getEdgesForNode:member(1)", "docComment": "/**\n * Get all edges connected to the specified node.\n *\n * @returns The edges connected to the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEdgesForNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getEdgesForNode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getIntersectingEdges:member(1)", "docComment": "/**\n * Get all edges that intersect the specified bounding box.\n *\n * @returns The intersecting edges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getIntersectingEdges(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getIntersectingEdges" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getIntersectingNodes:member(1)", "docComment": "/**\n * Get all nodes that intersect the specified bounding box.\n *\n * @returns The intersecting nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getIntersectingNodes(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getIntersectingNodes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getSelectionData:member(1)", "docComment": "/**\n * Get serialized data for the current selection.\n *\n * @returns The selection data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSelectionData(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSelectionData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getSnapping:member(1)", "docComment": "/**\n * Calculate snap alignment guides for the given position and dimensions.\n *\n * @returns The snap alignment data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSnapping(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg4: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "arg4", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "getSnapping" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getState:member(1)", "docComment": "/**\n * Get the current viewport state (position, zoom).\n *\n * @returns The viewport state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getState(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getViewportBBox:member(1)", "docComment": "/**\n * Get the bounding box of the current viewport in canvas coordinates.\n *\n * @returns The viewport bounding box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewportBBox(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewportBBox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getViewportNodes:member(1)", "docComment": "/**\n * Get all nodes currently visible within the viewport.\n *\n * @returns The viewport nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewportNodes(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getViewportNodes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#getZIndex:member(1)", "docComment": "/**\n * Get the next available z-index value.\n *\n * @returns The next z-index value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getZIndex(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getZIndex" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#gridSpacing:member", "docComment": "/**\n * Spacing between grid lines in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gridSpacing: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "gridSpacing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#handleCopy:member(1)", "docComment": "/**\n * Handle a copy event for the current selection.\n *\n * @returns The result of handling the copy event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleCopy(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleCopy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#handleCut:member(1)", "docComment": "/**\n * Handle a cut event for the current selection.\n *\n * @returns The result of handling the cut event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleCut(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleCut" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#handleDragToSelect:member(1)", "docComment": "/**\n * Handle drag-to-select (rubber band selection) interaction.\n *\n * @returns The result of handling the drag-to-select.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDragToSelect(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "handleDragToSelect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#handleDragWithPan:member(1)", "docComment": "/**\n * Handle drag interaction with viewport panning.\n *\n * @returns The result of handling the drag with pan.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDragWithPan(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "handleDragWithPan" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#handleMoverPointerdown:member(1)", "docComment": "/**\n * Handle pointer down event on the mover element.\n *\n * @returns The result of handling the pointer down.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleMoverPointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleMoverPointerdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#handlePaste:member(1)", "docComment": "/**\n * Handle a paste event to add items to the canvas.\n *\n * @returns The result of handling the paste event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handlePaste(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handlePaste" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#handleSelectionDrag:member(1)", "docComment": "/**\n * Handle dragging the current selection.\n *\n * @returns The result of handling the selection drag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleSelectionDrag(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "handleSelectionDrag" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#history:member", "docComment": "/**\n * Undo/redo history manager for canvas state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "history: " }, { "kind": "Reference", "text": "CanvasViewHistory", "canonicalReference": "obsidian-typings!CanvasViewHistory:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "history", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#hitTestNode:member(1)", "docComment": "/**\n * Test whether a point hits a specific node.\n *\n * @returns Whether the point hits the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hitTestNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "hitTestNode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#importData:member(1)", "docComment": "/**\n * Import canvas data from an external source.\n *\n * @returns The result of importing the data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "importData(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "importData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#interactionHitTest:member(1)", "docComment": "/**\n * Perform a hit test for interactive elements at the given position.\n *\n * @returns The hit interactive element, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interactionHitTest(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "interactionHitTest" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#isDragging:member", "docComment": "/**\n * Whether the user is currently dragging on the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDragging: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isDragging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#isHoldingSpace:member", "docComment": "/**\n * Whether the spacebar is currently held (for pan mode).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isHoldingSpace: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isHoldingSpace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#keys:member", "docComment": "/**\n * Map of currently pressed keyboard keys.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keys: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#lastEdgesInViewport:member", "docComment": "/**\n * Set of edges that were visible in the viewport on the last render frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastEdgesInViewport: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CanvasViewCanvasEdge", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastEdgesInViewport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#lastNodesInViewport:member", "docComment": "/**\n * Set of nodes that were visible in the viewport on the last render frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastNodesInViewport: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CanvasViewCanvasNode", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastNodesInViewport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#load:member(1)", "docComment": "/**\n * Load and initialize the canvas from saved data.\n *\n * @returns The result of loading the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "load(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "load" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#markDirty:member(1)", "docComment": "/**\n * Mark an item as dirty (needing to be saved).\n *\n * @returns The result of marking the item as dirty.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "markDirty(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "markDirty" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#markMoved:member(1)", "docComment": "/**\n * Mark an item as having been moved (needing re-indexing).\n *\n * @returns The result of marking the item as moved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "markMoved(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "markMoved" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#markViewportChanged:member(1)", "docComment": "/**\n * Mark the viewport as changed, triggering a re-render.\n *\n * @returns The result of marking the viewport as changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "markViewportChanged(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "markViewportChanged" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#menu:member", "docComment": "/**\n * Context menu and toolbar for the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "menu: " }, { "kind": "Reference", "text": "CanvasMenu", "canonicalReference": "obsidian-typings!CanvasMenu:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "menu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#moved:member", "docComment": "/**\n * Set of items that have been moved and need re-indexing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moved: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "moved", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#moverEl:member", "docComment": "/**\n * Element used for dragging/moving the canvas viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moverEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "moverEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#nodeIndex:member", "docComment": "/**\n * Spatial index (R-tree) for efficient node hit-testing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeIndex: " }, { "kind": "Reference", "text": "EdgeIndex", "canonicalReference": "obsidian-typings!EdgeIndex:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodeIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#nodeInteractionLayer:member", "docComment": "/**\n * Layer handling user interactions with nodes (resize, connect, etc.).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeInteractionLayer: " }, { "kind": "Reference", "text": "NodeInteractionLayer", "canonicalReference": "obsidian-typings!NodeInteractionLayer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodeInteractionLayer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#nodes:member", "docComment": "/**\n * Map of all nodes on the canvas, keyed by node ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodes: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CanvasViewCanvasNode", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#nudgeSelection:member(1)", "docComment": "/**\n * Nudge the current selection by the specified offset.\n *\n * @returns The result of nudging the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nudgeSelection(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "nudgeSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onContextMenu:member(1)", "docComment": "/**\n * Handle context menu event on the canvas background.\n *\n * @returns The result of handling the context menu event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onContextMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onContextMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onDoubleClick:member(1)", "docComment": "/**\n * Handle double-click event on the canvas.\n *\n * @returns The result of handling the double-click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDoubleClick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDoubleClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onGlobalKeydown:member(1)", "docComment": "/**\n * Handle global keydown events.\n *\n * @returns The result of handling the keydown event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onGlobalKeydown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onGlobalKeydown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onGlobalKeyup:member(1)", "docComment": "/**\n * Handle global keyup events.\n *\n * @returns The result of handling the keyup event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onGlobalKeyup(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onGlobalKeyup" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onKeydown:member(1)", "docComment": "/**\n * Handle keydown events on the canvas.\n *\n * @returns The result of handling the keydown event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeydown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeydown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onPointerdown:member(1)", "docComment": "/**\n * Handle pointer down events on the canvas.\n *\n * @returns The result of handling the pointer down event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onPointerdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onPointermove:member(1)", "docComment": "/**\n * Handle pointer move events on the canvas.\n *\n * @returns The result of handling the pointer move event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPointermove(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onPointermove" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onPriorityPointerdown:member(1)", "docComment": "/**\n * Handle priority pointer down events (processed before other handlers).\n *\n * @returns The result of handling the priority pointer down event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPriorityPointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onPriorityPointerdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onResize:member(1)", "docComment": "/**\n * Handle canvas container resize events.\n *\n * @returns The result of handling the resize event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onSelectionContextMenu:member(1)", "docComment": "/**\n * Handle context menu event on the current selection.\n *\n * @returns The result of handling the selection context menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSelectionContextMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onSelectionContextMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onTouchdown:member(1)", "docComment": "/**\n * Handle touch start events on the canvas.\n *\n * @returns The result of handling the touch event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTouchdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onTouchdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#onWheel:member(1)", "docComment": "/**\n * Handle mouse wheel events for zooming or panning.\n *\n * @returns The result of handling the wheel event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onWheel(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onWheel" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#options:member", "docComment": "/**\n * Optional configuration options for the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#overrideHistory:member(1)", "docComment": "/**\n * Override the current history entry with the latest state.\n *\n * @returns The result of overriding the history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overrideHistory(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "overrideHistory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#panBy:member(1)", "docComment": "/**\n * Pan the viewport by the specified delta.\n *\n * @returns The result of panning the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "panBy(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "panBy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#panIntoView:member(1)", "docComment": "/**\n * Pan the viewport so the specified bounding box is visible.\n *\n * @returns The result of panning into view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "panIntoView(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "panIntoView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#panTo:member(1)", "docComment": "/**\n * Pan the viewport to the specified position.\n *\n * @returns The result of panning the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "panTo(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "panTo" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#pauseAnimation:member", "docComment": "/**\n * Counter for pausing animation frames.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pauseAnimation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pauseAnimation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#pointer:member", "docComment": "/**\n * Current pointer position in canvas coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pointer: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "obsidian!Point:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pointer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#pointerFrame:member", "docComment": "/**\n * Animation frame request ID for pointer tracking.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pointerFrame: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pointerFrame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#pointerFrameWin:member", "docComment": "/**\n * Pointer frame window reference, null when not tracking.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pointerFrameWin: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pointerFrameWin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#posCenter:member(1)", "docComment": "/**\n * Get the center position of the current viewport.\n *\n * @returns The center position of the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "posCenter(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "posCenter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#posFromClient:member(1)", "docComment": "/**\n * Convert client (screen) coordinates to canvas coordinates.\n *\n * @returns The canvas coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "posFromClient(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "posFromClient" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#posFromDom:member(1)", "docComment": "/**\n * Convert DOM pixel coordinates to canvas coordinates.\n *\n * @returns The canvas coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "posFromDom(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "posFromDom" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#posFromEvt:member(1)", "docComment": "/**\n * Convert a DOM event's position to canvas coordinates.\n *\n * @returns The canvas coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "posFromEvt(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "posFromEvt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#posInViewport:member(1)", "docComment": "/**\n * Check whether a position is within the current viewport.\n *\n * @returns Whether the position is in the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "posInViewport(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "posInViewport" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#pushHistory:member(1)", "docComment": "/**\n * Push the current canvas state onto the undo history stack.\n *\n * @returns The result of pushing the history state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pushHistory(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "pushHistory" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#quickSettingsButton:member", "docComment": "/**\n * Button element for opening the quick settings menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "quickSettingsButton: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "quickSettingsButton", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#readonly:member", "docComment": "/**\n * Whether the canvas is in read-only mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "readonly", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#redo:member(1)", "docComment": "/**\n * Redo the last undone action.\n *\n * @returns The result of the redo operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redo(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "redo" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#redoBtnEl:member", "docComment": "/**\n * Button element for the redo action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redoBtnEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "redoBtnEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#removeEdge:member(1)", "docComment": "/**\n * Remove an edge from the canvas.\n *\n * @returns The result of removing the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeEdge(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeEdge" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#removeNode:member(1)", "docComment": "/**\n * Remove a node from the canvas.\n *\n * @returns The result of removing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeNode(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeNode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#renderSnapPoints:member(1)", "docComment": "/**\n * Render snap point guide lines for alignment.\n *\n * @returns The result of rendering snap points.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderSnapPoints(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg4: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "arg4", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "renderSnapPoints" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#requestFrame:member(1)", "docComment": "/**\n * Request an animation frame for rendering.\n *\n * @returns The animation frame request ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestFrame(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "requestFrame" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#requestPushHistory:member", "docComment": "/**\n * Debounced function to push the current state to history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestPushHistory: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestPushHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#requestSave:member(1)", "docComment": "/**\n * Request saving the canvas data to disk.\n *\n * @returns The result of requesting save.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestSave(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "requestSave" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#requestUpdateFileOpen:member", "docComment": "/**\n * Debounced function to update the file open state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestUpdateFileOpen: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestUpdateFileOpen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#rerenderViewport:member(1)", "docComment": "/**\n * Force a re-render of all items in the viewport.\n *\n * @returns The result of re-rendering the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rerenderViewport(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "rerenderViewport" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#scale:member", "docComment": "/**\n * Current zoom scale factor of the canvas viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#screenshotting:member", "docComment": "/**\n * Whether the canvas is currently being screenshotted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "screenshotting: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "screenshotting", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#select:member(1)", "docComment": "/**\n * Add an item to the current selection.\n *\n * @returns The result of selecting the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "select(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "select" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#selectAll:member(1)", "docComment": "/**\n * Select all nodes and edges on the canvas.\n *\n * @returns The result of selecting all items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectAll(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "selectAll" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#selection:member", "docComment": "/**\n * Set of currently selected nodes and edges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selection: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Selection", "canonicalReference": "!Selection:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#selectionChanged:member", "docComment": "/**\n * Whether the selection has changed since the last update.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectionChanged: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectionChanged", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#selectOnly:member(1)", "docComment": "/**\n * Select only the specified item, deselecting everything else.\n *\n * @returns The result of selecting only the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectOnly(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "selectOnly" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#setData:member(1)", "docComment": "/**\n * Set the canvas data, replacing existing nodes and edges.\n *\n * @returns The result of setting the data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setData(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#setDragging:member(1)", "docComment": "/**\n * Set the dragging state of the canvas.\n *\n * @returns The result of setting the dragging state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDragging(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setDragging" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#setReadonly:member(1)", "docComment": "/**\n * Set the read-only state of the canvas.\n *\n * @returns The result of setting the read-only state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setReadonly(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setReadonly" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#setState:member(1)", "docComment": "/**\n * Set the viewport state (position, zoom).\n *\n * @returns The result of setting the state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setState(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#setViewport:member(1)", "docComment": "/**\n * Set the viewport position and zoom level.\n *\n * @returns The result of setting the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setViewport(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "setViewport" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#showCreationMenu:member(1)", "docComment": "/**\n * Show the node creation menu at the specified position.\n *\n * @returns The result of showing the creation menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showCreationMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "showCreationMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#showQuickSettingsMenu:member(1)", "docComment": "/**\n * Show the quick settings menu for canvas options.\n *\n * @returns The result of showing the quick settings menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showQuickSettingsMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showQuickSettingsMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#smartZoom:member(1)", "docComment": "/**\n * Perform a smart zoom operation (toggle between zoom levels).\n *\n * @returns The result of the smart zoom.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "smartZoom(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "smartZoom" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#snapDistance:member", "docComment": "/**\n * Distance threshold for snapping behavior.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "snapDistance?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "snapDistance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#staleSelection:member", "docComment": "/**\n * Previously stale selection, null when selection is current.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "staleSelection: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "staleSelection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#takeScreenshot:member(1)", "docComment": "/**\n * Capture a screenshot of the canvas.\n *\n * @returns The captured screenshot.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "takeScreenshot(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "takeScreenshot" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#toggleGridSnapping:member(1)", "docComment": "/**\n * Toggle grid snapping on or off.\n *\n * @returns The result of toggling grid snapping.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleGridSnapping(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toggleGridSnapping" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#toggleObjectSnapping:member(1)", "docComment": "/**\n * Toggle object-to-object snapping on or off.\n *\n * @returns The result of toggling object snapping.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleObjectSnapping(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toggleObjectSnapping" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#toggleSelect:member(1)", "docComment": "/**\n * Toggle the selection state of an item.\n *\n * @returns The result of toggling the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleSelect(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toggleSelect" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#tx:member", "docComment": "/**\n * Target X translation for viewport animation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tx: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#ty:member", "docComment": "/**\n * Target Y translation for viewport animation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ty: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#tZoom:member", "docComment": "/**\n * Target zoom level for viewport animation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tZoom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tZoom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#undo:member(1)", "docComment": "/**\n * Undo the last action.\n *\n * @returns The result of the undo operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undo(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "undo" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#undoBtnEl:member", "docComment": "/**\n * Button element for the undo action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undoBtnEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "undoBtnEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#unload:member(1)", "docComment": "/**\n * Unload and clean up the canvas resources.\n *\n * @returns The result of unloading the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unload(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "unload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#updateFileOpen:member(1)", "docComment": "/**\n * Update the file open state for workspace tracking.\n *\n * @returns The result of updating the file open state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateFileOpen(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateFileOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#updateHistoryUI:member(1)", "docComment": "/**\n * Update the undo/redo button enabled states.\n *\n * @returns The result of updating the history UI.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateHistoryUI(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateHistoryUI" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#updateSelection:member(1)", "docComment": "/**\n * Update the visual state of the current selection.\n *\n * @returns The result of updating the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateSelection(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateSelection" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#view:member", "docComment": "/**\n * Reference to the parent {@link CanvasView}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "view: " }, { "kind": "Reference", "text": "CanvasView", "canonicalReference": "obsidian-typings!CanvasView:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#viewportChanged:member", "docComment": "/**\n * Whether the viewport has changed since the last render frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewportChanged: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewportChanged", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#virtualize:member(1)", "docComment": "/**\n * Virtualize off-screen nodes to improve performance.\n *\n * @returns The result of virtualizing nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "virtualize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "virtualize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#wasAnimating:member", "docComment": "/**\n * Whether the canvas was animating on the previous frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wasAnimating: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wasAnimating", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#wrapperEl:member", "docComment": "/**\n * Outermost wrapper element for the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wrapperEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wrapperEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#x:member", "docComment": "/**\n * Current X offset of the viewport in canvas coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#y:member", "docComment": "/**\n * Current Y offset of the viewport in canvas coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zIndexCounter:member", "docComment": "/**\n * Counter for assigning z-index values to nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zIndexCounter: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zIndexCounter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zoom:member", "docComment": "/**\n * Current zoom level of the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zoom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zoomBreakpoint:member", "docComment": "/**\n * Zoom level threshold for switching rendering detail levels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomBreakpoint?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "zoomBreakpoint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zoomBy:member(1)", "docComment": "/**\n * Zoom the viewport by a delta amount at the specified center point.\n *\n * @returns The result of zooming.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomBy(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "zoomBy" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zoomCenter:member", "docComment": "/**\n * Center point for zoom operations, null when not zooming.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomCenter: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zoomCenter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zoomToBbox:member(1)", "docComment": "/**\n * Zoom the viewport to fit the specified bounding box.\n *\n * @returns The result of zooming to the bounding box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomToBbox(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "zoomToBbox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zoomToFit:member(1)", "docComment": "/**\n * Zoom the viewport to fit all canvas content.\n *\n * @returns The result of zooming to fit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomToFit(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "zoomToFit" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zoomToFitQueued:member", "docComment": "/**\n * Whether a zoom-to-fit operation is queued for the next frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomToFitQueued: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zoomToFitQueued", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvas#zoomToSelection:member(1)", "docComment": "/**\n * Zoom the viewport to fit the current selection.\n *\n * @returns The result of zooming to the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomToSelection(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "zoomToSelection" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge:interface", "docComment": "/**\n * Represents a connection (edge) between two nodes on the canvas.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasEdge " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasEdge.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasEdge", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#attach:member(1)", "docComment": "/**\n * Attach the edge to the canvas DOM.\n *\n * @returns The result of attaching the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attach(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "attach" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#bbox:member", "docComment": "/**\n * Bounding box of the edge for spatial indexing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bbox: " }, { "kind": "Reference", "text": "BBox", "canonicalReference": "obsidian-typings!BBox:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bbox", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#bezier:member", "docComment": "/**\n * {@link Bezier} curve data used for rendering the edge path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bezier: " }, { "kind": "Reference", "text": "Bezier", "canonicalReference": "obsidian-typings!Bezier:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bezier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#blur:member(1)", "docComment": "/**\n * Remove focus from the edge.\n *\n * @returns The result of removing focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blur(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "blur" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#canvas:member", "docComment": "/**\n * Reference to the parent canvas instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas: " }, { "kind": "Reference", "text": "CanvasViewCanvas", "canonicalReference": "obsidian-typings!CanvasViewCanvas:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#color:member", "docComment": "/**\n * Color of the edge line (CSS color string or preset name).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#createEdgeEnd:member(1)", "docComment": "/**\n * Create a line end marker element for the specified end type.\n *\n * @returns The created edge end element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createEdgeEnd(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createEdgeEnd" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#deselect:member(1)", "docComment": "/**\n * Deselect the edge.\n *\n * @returns The result of deselecting the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deselect(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "deselect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#destroy:member(1)", "docComment": "/**\n * Destroy the edge and release its resources.\n *\n * @returns The result of destroying the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#detach:member(1)", "docComment": "/**\n * Detach the edge from the canvas DOM.\n *\n * @returns The result of detaching the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detach(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "detach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#editLabel:member(1)", "docComment": "/**\n * Open an inline editor for the edge's label.\n *\n * @returns The result of opening the label editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editLabel(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "editLabel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#focus:member(1)", "docComment": "/**\n * Set focus on the edge.\n *\n * @returns The result of focusing the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#from:member", "docComment": "/**\n * Link information for the source endpoint of the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Reference", "text": "CanvasViewCanvasEdgeLink", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLink:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#fromLineEnd:member", "docComment": "/**\n * Line end marker at the source endpoint, or `null` if none.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromLineEnd: " }, { "kind": "Reference", "text": "CanvasViewCanvasEdgeLineEnd", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLineEnd:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fromLineEnd", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#getBBox:member(1)", "docComment": "/**\n * Get the bounding box of the edge.\n *\n * @returns The bounding box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBBox(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBBox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#getCenter:member(1)", "docComment": "/**\n * Get the center point of the edge path.\n *\n * @returns The center point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCenter(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCenter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#getData:member(1)", "docComment": "/**\n * Get the serialized data for this edge.\n *\n * @returns The edge data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getData(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getData" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#id:member", "docComment": "/**\n * Unique identifier for this edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#initialize:member(1)", "docComment": "/**\n * Initialize the edge after construction.\n *\n * @returns The result of initializing the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initialize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#initialized:member", "docComment": "/**\n * Whether the edge has been initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialized: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "initialized", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#isAttached:member", "docComment": "/**\n * Whether the edge is currently attached to the canvas DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAttached?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isAttached", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#label:member", "docComment": "/**\n * Text label displayed on the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#lineEndGroupEl:member", "docComment": "/**\n * SVG group element containing the line end markers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineEndGroupEl: " }, { "kind": "Reference", "text": "SVGGElement", "canonicalReference": "!SVGGElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineEndGroupEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#lineGroupEl:member", "docComment": "/**\n * SVG group element containing the edge line paths.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineGroupEl: " }, { "kind": "Reference", "text": "SVGGElement", "canonicalReference": "!SVGGElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineGroupEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#onClick:member(1)", "docComment": "/**\n * Handle click events on the edge.\n *\n * @returns The result of handling the click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onClick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#onConnectionPointerdown:member(1)", "docComment": "/**\n * Handle pointer down on a connection point to start re-routing.\n *\n * @returns The result of handling the connection pointer down.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onConnectionPointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onConnectionPointerdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#onContextMenu:member(1)", "docComment": "/**\n * Handle context menu events on the edge.\n *\n * @returns The result of handling the context menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onContextMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onContextMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#path:member", "docComment": "/**\n * SVG path elements for the edge (display and interaction).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Reference", "text": "CanvasViewCanvasEdgePath", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgePath:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#render:member(1)", "docComment": "/**\n * Render the edge to the canvas.\n *\n * @returns The result of rendering the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#select:member(1)", "docComment": "/**\n * Mark the edge as selected.\n *\n * @returns The result of selecting the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "select(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "select" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#setColor:member(1)", "docComment": "/**\n * Set the color of the edge.\n *\n * @returns The result of setting the color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setColor(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setColor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#setData:member(1)", "docComment": "/**\n * Set the serialized data for this edge.\n *\n * @returns The result of setting the data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setData(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#setLabel:member(1)", "docComment": "/**\n * Set the text label of the edge.\n *\n * @returns The result of setting the label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setLabel(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setLabel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#showMenu:member(1)", "docComment": "/**\n * Show the context menu for this edge.\n *\n * @returns The result of showing the menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#to:member", "docComment": "/**\n * Link information for the target endpoint of the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Reference", "text": "CanvasViewCanvasEdgeLink", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLink:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#toLineEnd:member", "docComment": "/**\n * Line end marker at the target endpoint, or `null` if none.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toLineEnd: " }, { "kind": "Reference", "text": "CanvasViewCanvasEdgeLineEnd", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLineEnd:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toLineEnd", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#unknownData:member", "docComment": "/**\n * Additional data properties not covered by known fields.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unknownData: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unknownData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#update:member(1)", "docComment": "/**\n * Update the edge after its connected nodes have moved.\n *\n * @returns The result of updating the edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge#updatePath:member(1)", "docComment": "/**\n * Recalculate and update the SVG path of the edge.\n *\n * @returns The result of updating the path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updatePath(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updatePath" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLineEnd:interface", "docComment": "/**\n * Represents the visual endpoint (arrow, dot, etc.) at one end of a canvas edge.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasEdgeLineEnd " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasEdgeLineEnd.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasEdgeLineEnd", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLineEnd#el:member", "docComment": "/**\n * SVG group element containing the line end marker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "el: " }, { "kind": "Reference", "text": "SVGGElement", "canonicalReference": "!SVGGElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "el", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLineEnd#type:member", "docComment": "/**\n * Type of the line end marker (e.g., 'arrow', 'none').\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLink:interface", "docComment": "/**\n * Represents one endpoint of a canvas edge, linking it to a specific side of a node.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasEdgeLink " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasEdgeLink.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasEdgeLink", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLink#end:member", "docComment": "/**\n * Which end of the edge this link represents ('from' or 'to').\n */\n", "excerptTokens": [ { "kind": "Content", "text": "end: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "end", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLink#node:member", "docComment": "/**\n * The node this edge endpoint is connected to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "node: " }, { "kind": "Reference", "text": "CanvasViewCanvasNode", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "node", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgeLink#side:member", "docComment": "/**\n * The side of the node where this edge connects (e.g., 'top', 'bottom', 'left', 'right').\n */\n", "excerptTokens": [ { "kind": "Content", "text": "side: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "side", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgePath:interface", "docComment": "/**\n * SVG path elements for rendering a canvas edge, with separate paths for display and interaction.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasEdgePath " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasEdgePath.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasEdgePath", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgePath#display:member", "docComment": "/**\n * SVG path element used for the visible edge rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "display: " }, { "kind": "Reference", "text": "SVGPathElement", "canonicalReference": "!SVGPathElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "display", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdgePath#interaction:member", "docComment": "/**\n * SVG path element used as a wider invisible hit area for interaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interaction: " }, { "kind": "Reference", "text": "SVGPathElement", "canonicalReference": "!SVGPathElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "interaction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode:interface", "docComment": "/**\n * Represents a node on the canvas with position, size, content, and connection capabilities.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasNode extends " }, { "kind": "Reference", "text": "CanvasViewCanvasNodeBase", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasNode.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasNode", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#alwaysKeepLoaded:member", "docComment": "/**\n * Whether this node should always remain loaded even when off-screen.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alwaysKeepLoaded: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "alwaysKeepLoaded", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#app:member", "docComment": "/**\n * Reference to the Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#aspectRatio:member", "docComment": "/**\n * Aspect ratio of the node (width / height).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "aspectRatio: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "aspectRatio", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#bbox:member", "docComment": "/**\n * Bounding box of the node for spatial indexing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bbox: " }, { "kind": "Reference", "text": "BBox", "canonicalReference": "obsidian-typings!BBox:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bbox", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#blur:member(1)", "docComment": "/**\n * Remove focus from the node.\n *\n * @returns The result of removing focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blur(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "blur" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#canvas:member", "docComment": "/**\n * Reference to the parent canvas instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas: " }, { "kind": "Reference", "text": "CanvasViewCanvas", "canonicalReference": "obsidian-typings!CanvasViewCanvas:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#child:member", "docComment": "/**\n * Child editor view for the node's content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "child: " }, { "kind": "Reference", "text": "WidgetEditorView", "canonicalReference": "obsidian-typings!WidgetEditorView:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "child", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#color:member", "docComment": "/**\n * Color of the node (CSS color string or preset name).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#containerEl:member", "docComment": "/**\n * Outermost container element of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#contentBlockerEl:member", "docComment": "/**\n * Overlay element that blocks interaction with content when not editing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentBlockerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentBlockerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#contentEl:member", "docComment": "/**\n * Element containing the node's editable content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#destroyed:member", "docComment": "/**\n * Whether the node has been destroyed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroyed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "destroyed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#file:member", "docComment": "/**\n * Reference to the associated file, if this is a file node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#filePath:member", "docComment": "/**\n * Path to the associated file, if this is a file node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#focus:member(1)", "docComment": "/**\n * Set focus on the node.\n *\n * @returns The result of focusing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#getData:member(1)", "docComment": "/**\n * Get the serialized data for this node.\n *\n * @returns The node data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getData(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getData" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#height:member", "docComment": "/**\n * Height of the node in canvas units.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#id:member", "docComment": "/**\n * Unique identifier for this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#initFile:member(1)", "docComment": "/**\n * Initialize the file association for a file-type node.\n *\n * @returns The result of initializing the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initFile(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#initialize:member(1)", "docComment": "/**\n * Initialize the node after construction.\n *\n * @returns The result of initializing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initialize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#initialized:member", "docComment": "/**\n * Whether the node has been initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialized: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "initialized", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#isContentMounted:member", "docComment": "/**\n * Whether the node's content is currently mounted in the DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isContentMounted: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isContentMounted", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#isEditing:member", "docComment": "/**\n * Whether the node is currently in editing mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEditing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isEditing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#nodeEl:member", "docComment": "/**\n * Main node element for rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodeEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#onFileFocus:member(1)", "docComment": "/**\n * Handle the node's file receiving focus.\n *\n * @returns The result of handling the file focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileFocus(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFileFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#onLabelClick:member(1)", "docComment": "/**\n * Handle click events on the node's label.\n *\n * @returns The result of handling the label click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onLabelClick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onLabelClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#onLabelDblClick:member(1)", "docComment": "/**\n * Handle double-click events on the node's label.\n *\n * @returns The result of handling the label double-click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onLabelDblClick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onLabelDblClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#onPointerdown:member(1)", "docComment": "/**\n * Handle pointer down events on the node.\n *\n * @returns The result of handling the pointer down.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onPointerdown" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#placeholderEl:member", "docComment": "/**\n * Placeholder element shown while the node content is loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "placeholderEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "placeholderEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#render:member(1)", "docComment": "/**\n * Render the node to the canvas.\n *\n * @returns The result of rendering the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#renderedZIndex:member", "docComment": "/**\n * The last rendered z-index value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderedZIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderedZIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#resizeDirty:member", "docComment": "/**\n * Whether the node needs to recalculate its size.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resizeDirty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resizeDirty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#setData:member(1)", "docComment": "/**\n * Set the serialized data for this node.\n *\n * @returns The result of setting the data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setData(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#setFile:member(1)", "docComment": "/**\n * Set the file associated with this node.\n *\n * @returns The result of setting the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFile(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "setFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#setFilePath:member(1)", "docComment": "/**\n * Set the file path for this node.\n *\n * @returns The result of setting the file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFilePath(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setFilePath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#showMenu:member(1)", "docComment": "/**\n * Show the context menu for this node.\n *\n * @returns The result of showing the menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#subpath:member", "docComment": "/**\n * Subpath within the linked file (e.g., heading or block reference).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subpath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#unknownData:member", "docComment": "/**\n * Additional data properties not covered by known fields.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unknownData: " }, { "kind": "Reference", "text": "CanvasViewCanvasNodeUnknownData", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeUnknownData:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unknownData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#updateBreakpoint:member(1)", "docComment": "/**\n * Update the rendering breakpoint based on the node's current size.\n *\n * @returns The result of updating the breakpoint.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateBreakpoint(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateBreakpoint" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#updateNodeLabel:member(1)", "docComment": "/**\n * Update the displayed label text of the node.\n *\n * @returns The result of updating the node label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateNodeLabel(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateNodeLabel" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#width:member", "docComment": "/**\n * Width of the node in canvas units.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#x:member", "docComment": "/**\n * X coordinate of the node's top-left corner in canvas space.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#y:member", "docComment": "/**\n * Y coordinate of the node's top-left corner in canvas space.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNode#zIndex:member", "docComment": "/**\n * Z-index stacking order of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase:interface", "docComment": "/**\n * Base interface for canvas nodes, providing core editing and interaction methods.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasNodeBase extends " }, { "kind": "Reference", "text": "CanvasViewCanvasNodeBaseBase", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasNodeBase.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasNodeBase", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#blur:member(1)", "docComment": "/**\n * Remove focus from the node.\n *\n * @returns The result of removing focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blur(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "blur" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#destroy:member(1)", "docComment": "/**\n * Destroy the node and release its resources.\n *\n * @returns The result of destroying the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#focus:member(1)", "docComment": "/**\n * Set focus on the node.\n *\n * @returns The result of focusing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#initialize:member(1)", "docComment": "/**\n * Initialize the node after construction.\n *\n * @returns The result of initializing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#isEditable:member(1)", "docComment": "/**\n * Check whether this node supports editing.\n *\n * @returns Whether the node is editable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEditable(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isEditable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#moveAndResize:member(1)", "docComment": "/**\n * Move and resize the node to the specified bounds.\n *\n * @returns The result of moving and resizing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveAndResize(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "moveAndResize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#onClick:member(1)", "docComment": "/**\n * Handle click events on the node.\n *\n * @returns The result of handling the click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onClick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#onResizeDblclick:member(1)", "docComment": "/**\n * Handle double-click on a resize handle to auto-size the node.\n *\n * @returns The result of handling the resize double-click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResizeDblclick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onResizeDblclick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#render:member(1)", "docComment": "/**\n * Render the node to the canvas.\n *\n * @returns The result of rendering the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#startEditing:member(1)", "docComment": "/**\n * Enter editing mode for the node's content.\n *\n * @returns The result of starting editing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startEditing(arg1?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "startEditing" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBase#unloadChild:member(1)", "docComment": "/**\n * Unload the child editor view.\n *\n * @returns The result of unloading the child.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unloadChild(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "unloadChild" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase:interface", "docComment": "/**\n * Intermediate base interface for canvas nodes, adding lifecycle and content mounting methods.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasNodeBaseBase extends " }, { "kind": "Reference", "text": "CanvasViewCanvasNodeBaseBaseBase", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasNodeBaseBase.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasNodeBaseBase", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase#attach:member(1)", "docComment": "/**\n * Attach the node to the canvas DOM.\n *\n * @returns The result of attaching the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attach(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "attach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase#detach:member(1)", "docComment": "/**\n * Detach the node from the canvas DOM.\n *\n * @returns The result of detaching the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detach(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "detach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase#initialize:member(1)", "docComment": "/**\n * Initialize the node after construction.\n *\n * @returns The result of initializing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase#mountContent:member(1)", "docComment": "/**\n * Mount the node's content into the content container.\n *\n * @returns The result of mounting the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mountContent(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "mountContent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase#preDetach:member(1)", "docComment": "/**\n * Perform cleanup before detaching the node.\n *\n * @returns The result of pre-detach cleanup.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preDetach(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "preDetach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase#unmountContent:member(1)", "docComment": "/**\n * Unmount the node's content from the content container.\n *\n * @returns The result of unmounting the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unmountContent(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "unmountContent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBase#updateBreakpoint:member(1)", "docComment": "/**\n * Update the rendering breakpoint based on the node's current size.\n *\n * @returns The result of updating the breakpoint.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateBreakpoint(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateBreakpoint" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase:interface", "docComment": "/**\n * Lowest-level base interface for canvas nodes, providing core properties and interaction methods.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasNodeBaseBaseBase " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasNodeBaseBaseBase.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasNodeBaseBaseBase", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#attach:member(1)", "docComment": "/**\n * Attach the node to the canvas DOM.\n *\n * @returns The result of attaching the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attach(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "attach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#blur:member(1)", "docComment": "/**\n * Remove focus from the node.\n *\n * @returns The result of removing focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blur(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "blur" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#deselect:member(1)", "docComment": "/**\n * Deselect the node.\n *\n * @returns The result of deselecting the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deselect(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "deselect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#destroy:member(1)", "docComment": "/**\n * Destroy the node and release its resources.\n *\n * @returns The result of destroying the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#detach:member(1)", "docComment": "/**\n * Detach the node from the canvas DOM.\n *\n * @returns The result of detaching the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detach(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "detach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#focus:member(1)", "docComment": "/**\n * Set focus on the node.\n *\n * @returns The result of focusing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#getBBox:member(1)", "docComment": "/**\n * Get the bounding box of the node.\n *\n * @returns The bounding box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBBox(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBBox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#getConnectedFiles:member(1)", "docComment": "/**\n * Get all files connected to this node via edges.\n *\n * @returns The connected files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getConnectedFiles(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getConnectedFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#getData:member(1)", "docComment": "/**\n * Get the serialized data for this node.\n *\n * @returns The node data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getData(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#initialize:member(1)", "docComment": "/**\n * Initialize the node after construction.\n *\n * @returns The result of initializing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initialize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#isAttached:member", "docComment": "/**\n * Whether the node is currently attached to the canvas DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAttached?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isAttached", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#isEditable:member(1)", "docComment": "/**\n * Check whether this node supports editing.\n *\n * @returns Whether the node is editable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEditable(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isEditable" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#isFocused:member", "docComment": "/**\n * Whether the node currently has focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isFocused?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isFocused", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#moveAndResize:member(1)", "docComment": "/**\n * Move and resize the node to the specified bounds.\n *\n * @returns The result of moving and resizing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveAndResize(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "moveAndResize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#moveTo:member(1)", "docComment": "/**\n * Move the node to the specified position.\n *\n * @returns The result of moving the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveTo(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "moveTo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#onClick:member(1)", "docComment": "/**\n * Handle click events on the node.\n *\n * @returns The result of handling the click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onClick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#onConnectionPointerdown:member(1)", "docComment": "/**\n * Handle pointer down on a connection handle to start edge creation.\n *\n * @returns The result of handling the connection pointer down.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onConnectionPointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onConnectionPointerdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#onContextMenu:member(1)", "docComment": "/**\n * Handle context menu events on the node.\n *\n * @returns The result of handling the context menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onContextMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onContextMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#onPointerdown:member(1)", "docComment": "/**\n * Handle pointer down events on the node.\n *\n * @returns The result of handling the pointer down.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onPointerdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#onResizeDblclick:member(1)", "docComment": "/**\n * Handle double-click on a resize handle to auto-size the node.\n *\n * @returns The result of handling the resize double-click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResizeDblclick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onResizeDblclick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#onResizePointerdown:member(1)", "docComment": "/**\n * Handle pointer down on a resize handle to start resizing.\n *\n * @returns The result of handling the resize pointer down.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResizePointerdown(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onResizePointerdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#preDetach:member(1)", "docComment": "/**\n * Perform cleanup before detaching the node.\n *\n * @returns The result of pre-detach cleanup.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preDetach(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "preDetach" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#rect:member", "docComment": "/**\n * Bounding rectangle of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rect: " }, { "kind": "Reference", "text": "CanvasRect", "canonicalReference": "!CanvasRect:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#render:member(1)", "docComment": "/**\n * Render the node to the canvas.\n *\n * @returns The result of rendering the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#renderZIndex:member(1)", "docComment": "/**\n * Render the node's z-index CSS property.\n *\n * @returns The result of rendering the z-index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderZIndex(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "renderZIndex" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#resize:member(1)", "docComment": "/**\n * Resize the node to the specified dimensions.\n *\n * @returns The result of resizing the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resize(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "resize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#select:member(1)", "docComment": "/**\n * Mark the node as selected.\n *\n * @returns The result of selecting the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "select(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "select" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#setColor:member(1)", "docComment": "/**\n * Set the color of the node.\n *\n * @returns The result of setting the color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setColor(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setColor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#setData:member(1)", "docComment": "/**\n * Set the serialized data for this node.\n *\n * @returns The result of setting the data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setData(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#setIsEditing:member(1)", "docComment": "/**\n * Set whether the node is in editing mode.\n *\n * @returns The result of setting the editing state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIsEditing(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setIsEditing" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#showMenu:member(1)", "docComment": "/**\n * Show the context menu for this node.\n *\n * @returns The result of showing the menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#startEditing:member(1)", "docComment": "/**\n * Enter editing mode for the node's content.\n *\n * @returns The result of starting editing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startEditing(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "startEditing" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#updateBreakpoint:member(1)", "docComment": "/**\n * Update the rendering breakpoint based on the node's current size.\n *\n * @returns The result of updating the breakpoint.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateBreakpoint(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateBreakpoint" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeBaseBaseBase#updateZIndex:member(1)", "docComment": "/**\n * Update the z-index of the node in the stacking order.\n *\n * @returns The result of updating the z-index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateZIndex(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateZIndex" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeUnknownData:interface", "docComment": "/**\n * Base data shared by all canvas node types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewCanvasNodeUnknownData " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewCanvasNodeUnknownData.d.ts", "releaseTag": "Public", "name": "CanvasViewCanvasNodeUnknownData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeUnknownData#file:member", "docComment": "/**\n * Path to the associated file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeUnknownData#id:member", "docComment": "/**\n * Unique identifier of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeUnknownData#type:member", "docComment": "/**\n * Type of the canvas node (e.g. \"text\", \"file\", \"link\", \"group\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewConfig:interface", "docComment": "/**\n * Configuration options for the canvas view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewConfig " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewConfig.d.ts", "releaseTag": "Public", "name": "CanvasViewConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewConfig#defaultFileNodeDimensions:member", "docComment": "/**\n * Default dimensions for newly created file nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultFileNodeDimensions: " }, { "kind": "Reference", "text": "Dimensions", "canonicalReference": "obsidian-typings!Dimensions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultFileNodeDimensions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewConfig#defaultTextNodeDimensions:member", "docComment": "/**\n * Default dimensions for newly created text nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultTextNodeDimensions: " }, { "kind": "Reference", "text": "Dimensions", "canonicalReference": "obsidian-typings!Dimensions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultTextNodeDimensions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewConfig#minContainerDimension:member", "docComment": "/**\n * Minimum dimension (width or height) for container/group nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minContainerDimension: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minContainerDimension", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewConfig#objectSnapDistance:member", "docComment": "/**\n * Distance threshold in pixels for snapping objects to each other.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "objectSnapDistance: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "objectSnapDistance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewConfig#zoomMultiplier:member", "docComment": "/**\n * Multiplier applied to zoom increments.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomMultiplier: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zoomMultiplier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewData:interface", "docComment": "/**\n * Serialized canvas data containing all nodes and edges.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewData " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasData.d.ts", "releaseTag": "Public", "name": "CanvasViewData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewData#edges:member", "docComment": "/**\n * Array of serialized edge data for all connections in the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "edges: " }, { "kind": "Reference", "text": "CanvasViewDataEdge", "canonicalReference": "obsidian-typings!CanvasViewDataEdge:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "edges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewData#nodes:member", "docComment": "/**\n * Array of serialized node data for all nodes in the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodes: " }, { "kind": "Reference", "text": "CanvasViewDataNode", "canonicalReference": "obsidian-typings!CanvasViewDataNode:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewDataEdge:interface", "docComment": "/**\n * Serialized data representation of an edge (connection) between two nodes in the canvas.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewDataEdge " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewDataEdge.d.ts", "releaseTag": "Public", "name": "CanvasViewDataEdge", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataEdge#fromNode:member", "docComment": "/**\n * ID of the source node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromNode: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fromNode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataEdge#fromSide:member", "docComment": "/**\n * {@link obsidian#Side} of the source node where the edge originates (e.g., 'top', 'bottom', 'left', 'right').\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromSide: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fromSide", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataEdge#id:member", "docComment": "/**\n * Unique identifier for this edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataEdge#toNode:member", "docComment": "/**\n * ID of the target node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toNode: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toNode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataEdge#toSide:member", "docComment": "/**\n * {@link obsidian#Side} of the target node where the edge terminates (e.g., 'top', 'bottom', 'left', 'right').\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toSide: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toSide", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewDataNode:interface", "docComment": "/**\n * Serialized data for a canvas node.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewDataNode extends " }, { "kind": "Reference", "text": "CanvasViewCanvasNodeUnknownData", "canonicalReference": "obsidian-typings!CanvasViewCanvasNodeUnknownData:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewDataNode.d.ts", "releaseTag": "Public", "name": "CanvasViewDataNode", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataNode#height:member", "docComment": "/**\n * Height of the node in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataNode#subpath:member", "docComment": "/**\n * Subpath within the file (e.g. heading or block reference).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subpath?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "subpath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataNode#width:member", "docComment": "/**\n * Width of the node in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataNode#x:member", "docComment": "/**\n * X position of the node on the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewDataNode#y:member", "docComment": "/**\n * Y position of the node on the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CanvasViewHistory:interface", "docComment": "/**\n * Manages undo/redo history for canvas state changes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CanvasViewHistory " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/CanvasViewHistory.d.ts", "releaseTag": "Public", "name": "CanvasViewHistory", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#canRedo:member(1)", "docComment": "/**\n * Check whether a redo operation is available.\n *\n * @returns Whether redo is available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canRedo(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canRedo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#canUndo:member(1)", "docComment": "/**\n * Check whether an undo operation is available.\n *\n * @returns Whether undo is available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canUndo(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canUndo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#clear:member(1)", "docComment": "/**\n * Clear all history entries.\n *\n * @returns The result of clearing the history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#current:member", "docComment": "/**\n * Index of the current state in the history stack.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "current: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "current", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#data:member", "docComment": "/**\n * Array of historical canvas states.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "CanvasViewData", "canonicalReference": "obsidian-typings!CanvasViewData:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#max:member", "docComment": "/**\n * Maximum number of history entries to retain.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "max: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "max", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#push:member(1)", "docComment": "/**\n * Push a new state onto the history stack.\n *\n * @returns The result of pushing the state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "push(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "push" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#redo:member(1)", "docComment": "/**\n * Redo the last undone action and return the restored state.\n *\n * @returns The restored state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redo(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "redo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#replace:member(1)", "docComment": "/**\n * Replace the current history entry with a new state.\n *\n * @returns The result of replacing the history entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replace(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "replace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CanvasViewHistory#undo:member(1)", "docComment": "/**\n * Undo the last action and return the previous state.\n *\n * @returns The previous state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undo(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "undo" } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!Capacitor_2:var", "docComment": "/**\n * Capacitor global instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Capacitor: " }, { "kind": "Reference", "text": "CapacitorGlobal", "canonicalReference": "obsidian-typings!CapacitorGlobal:interface" } ], "fileUrlPath": "src/@capacitor__core/internals/vars/Capacitor.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "Capacitor_2", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CapacitorAdapterFs:interface", "docComment": "/**\n * File system adapter for Capacitor (mobile) platform.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CapacitorAdapterFs " } ], "fileUrlPath": "src/obsidian/internals/CapacitorAdapterFs.d.ts", "releaseTag": "Public", "name": "CapacitorAdapterFs", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#append:member(1)", "docComment": "/**\n * Append text data to a file.\n *\n * @param realPath - Real file system path.\n *\n * @param data - Text data to append.\n *\n * @returns A promise that resolves when the data is appended. To extract the constructor type, use {@link ExtractConstructor | ExtractConstructor\\<CapacitorAdapterFs\\>}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "append(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "append" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To extract the constructor type, use {@link ExtractConstructor | ExtractConstructor\\<CapacitorAdapterFs\\>}.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param dir - The dir.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(dir: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "dir", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#copy:member(1)", "docComment": "/**\n * Copy a file to a new path.\n *\n * @param realPath - Source file path.\n *\n * @param newRealPath - Destination file path.\n *\n * @returns A promise that resolves when the file is copied.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copy(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", newRealPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newRealPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "copy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#delete:member(1)", "docComment": "/**\n * Delete a file at the given path.\n *\n * @param realPath - File path to delete.\n *\n * @returns A promise that resolves when the file is deleted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "delete(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "delete" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#dir:member", "docComment": "/**\n * Base directory path for the file system, or `null` if not initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dir: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dir", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#exists:member(1)", "docComment": "/**\n * Check whether a file exists at the given path.\n *\n * @param realPath - File path to check.\n *\n * @returns Whether the file exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exists(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<boolean>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "exists" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#getNativeUri:member(1)", "docComment": "/**\n * Get the native platform URI for a file path.\n *\n * @param realPath - File path.\n *\n * @returns Native URI string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNativeUri(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getNativeUri" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#getUri:member(1)", "docComment": "/**\n * Get the URI for a file path.\n *\n * @param realPath - File path.\n *\n * @returns URI string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getUri(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getUri" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#init:member(1)", "docComment": "/**\n * Initialize the file system adapter.\n *\n * @returns A promise that resolves when the adapter is initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "init(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "init" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#mkdir:member(1)", "docComment": "/**\n * Create a directory at the given path.\n *\n * @param realPath - Directory path to create.\n *\n * @returns A promise that resolves when the directory is created.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mkdir(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "mkdir" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#open:member(1)", "docComment": "/**\n * Open a file using the native platform handler.\n *\n * @param realPath - File path to open.\n *\n * @returns A promise that resolves when the file is opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "open(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "open" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#read:member(1)", "docComment": "/**\n * Read a file as text.\n *\n * @param realPath - File path to read.\n *\n * @returns Text content of the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "read(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "read" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#readBinary:member(1)", "docComment": "/**\n * Read a file as binary data.\n *\n * @param realPath - File path to read.\n *\n * @returns Binary content of the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readBinary(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "readBinary" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#readdir:member(1)", "docComment": "/**\n * List entries in a directory.\n *\n * @param realPath - Directory path to list.\n *\n * @returns Array of file entries in the directory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readdir(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CapacitorFileEntry", "canonicalReference": "obsidian-typings!CapacitorFileEntry:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "readdir" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#rename:member(1)", "docComment": "/**\n * Rename or move a file to a new path.\n *\n * @param realPath - Current file path.\n *\n * @param newRealPath - New file path.\n *\n * @returns A promise that resolves when the file is renamed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rename(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", newRealPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newRealPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "rename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#rmdir:member(1)", "docComment": "/**\n * Remove a directory.\n *\n * @param realPath - Directory path to remove.\n *\n * @returns A promise that resolves when the directory is removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rmdir(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "rmdir" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#setTimes:member(1)", "docComment": "/**\n * Set the creation and modification times for a file.\n *\n * @param realPath - File path.\n *\n * @param ctime - Creation time in milliseconds.\n *\n * @param mtime - Modification time in milliseconds.\n *\n * @returns A promise that resolves when the times are set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTimes(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ctime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", mtime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ctime", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "mtime", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "setTimes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#stat:member(1)", "docComment": "/**\n * Get file statistics for the given path.\n *\n * @param realPath - File path to stat.\n *\n * @returns File entry with statistics.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stat(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CapacitorFileEntry", "canonicalReference": "obsidian-typings!CapacitorFileEntry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "stat" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#trash:member(1)", "docComment": "/**\n * Move a file to the system trash.\n *\n * @param realPath - File path to trash.\n *\n * @returns A promise that resolves when the file is trashed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trash(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "trash" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#uri:member", "docComment": "/**\n * Base URI for the file system.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uri: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "uri", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#verifyIcloud:member(1)", "docComment": "/**\n * Verify and download an iCloud file if it is not yet available locally.\n *\n * @param realPath - File path to verify.\n *\n * @returns A promise that resolves when the iCloud file is verified.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "verifyIcloud(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "verifyIcloud" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#watch:member(1)", "docComment": "/**\n * Start watching a path for file system changes.\n *\n * @param realPath - Path to watch.\n *\n * @returns A promise that resolves when the watcher is started.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "watch(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "watch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#watchAndStatAll:member(1)", "docComment": "/**\n * Watch a path and return stat information for all contained files.\n *\n * @param realPath - Path to watch and stat.\n *\n * @returns Stat results for all files in the watched path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "watchAndStatAll(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WatchAndStatAllResult", "canonicalReference": "obsidian-typings!WatchAndStatAllResult:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "watchAndStatAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#write:member(1)", "docComment": "/**\n * Write text data to a file.\n *\n * @param realPath - File path to write to.\n *\n * @param data - Text data to write.\n *\n * @returns A promise that resolves when the file is written.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "write(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "write" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#writeBinary:member(1)", "docComment": "/**\n * Write binary data to a file.\n *\n * @param realPath - File path to write to.\n *\n * @param data - Binary data to write.\n *\n * @returns A promise that resolves when the file is written.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeBinary(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", data: " }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "writeBinary" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorAdapterFs#writeBinaryInternal:member(1)", "docComment": "/**\n * Write binary data to a file using the internal storage path.\n *\n * @param realPath - File path to write to.\n *\n * @param data - Binary data to write.\n *\n * @returns A promise that resolves when the file is written.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeBinaryInternal(realPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", data: " }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "realPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "writeBinaryInternal" } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!CapacitorException:class", "docComment": "/**\n * Capacitor exception.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class CapacitorException extends " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/@capacitor__core/internals/CapacitorException.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "CapacitorException", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!CapacitorException:constructor(1)", "docComment": "/**\n * Creates a new CapacitorException.\n *\n * @param message - Exception message.\n *\n * @param code - Exception code.\n *\n * @param data - Exception data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", code?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", data?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!CapacitorException#code:member", "docComment": "/**\n * Exception code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly code?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": true, "releaseTag": "Public", "name": "code", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!CapacitorException#data:member", "docComment": "/**\n * Exception data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly data?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": true, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!CapacitorException#message:member", "docComment": "/**\n * Exception message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CapacitorFileEntry:interface", "docComment": "/**\n * File or directory entry from the Capacitor (mobile) file system.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CapacitorFileEntry extends " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileStats", "canonicalReference": "obsidian!FileStats:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/CapacitorFileEntry.d.ts", "releaseTag": "Public", "name": "CapacitorFileEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorFileEntry#name:member", "docComment": "/**\n * Name of the file or directory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorFileEntry#type:member", "docComment": "/**\n * Whether this entry is a file or directory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'directory' | 'file'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorFileEntry#uri:member", "docComment": "/**\n * URI of the file or directory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uri: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "uri", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CapacitorGlobal:interface", "docComment": "/**\n * Capacitor global instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CapacitorGlobal " } ], "fileUrlPath": "src/@capacitor__core/internals/CapacitorGlobal.d.ts", "releaseTag": "Public", "name": "CapacitorGlobal", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#addListener:member(1)", "docComment": "/**\n * Adds a listener for a plugin event.\n *\n * @param pluginName - Plugin name.\n *\n * @param eventName - Event name.\n *\n * @param callback - Event callback.\n *\n * @returns Plugin listener handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener?(pluginName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", eventName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Reference", "text": "PluginCallback", "canonicalReference": "obsidian-typings!PluginCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PluginListenerHandle", "canonicalReference": "obsidian-typings!PluginListenerHandle:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pluginName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#convertFileSrc:member(1)", "docComment": "/**\n * Converts a file path to a source URL.\n *\n * @param filePath - File path.\n *\n * @returns Source URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "convertFileSrc(filePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filePath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "convertFileSrc" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#DEBUG:member", "docComment": "/**\n * Whether debug mode is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "DEBUG?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "DEBUG", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#Exception:member", "docComment": "/**\n * Capacitor exception class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Exception: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "CapacitorException", "canonicalReference": "obsidian-typings!CapacitorException:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Exception", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#getPlatform:member(1)", "docComment": "/**\n * Gets the current platform name.\n *\n * @returns Platform name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPlatform(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPlatform" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#isLoggingEnabled:member", "docComment": "/**\n * Whether logging is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isLoggingEnabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isLoggingEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#isNative:member", "docComment": "/**\n * Whether the platform is native. `@deprecated` Deprecated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isNative?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isNative", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#isNativePlatform:member(1)", "docComment": "/**\n * Checks if the platform is native.\n *\n * @returns Whether the platform is native.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isNativePlatform(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isNativePlatform" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#isPluginAvailable:member(1)", "docComment": "/**\n * Checks if a plugin is available.\n *\n * @param name - Plugin name.\n *\n * @returns Whether the plugin is available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPluginAvailable(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isPluginAvailable" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#platform:member", "docComment": "/**\n * Platform name. `@deprecated` Deprecated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "platform?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "platform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#pluginMethodNoop:member(1)", "docComment": "/**\n * No-op for plugin methods.\n *\n * @deprecated\n *\n * Deprecated.\n *\n * @param target - Target object.\n *\n * @param key - Property key.\n *\n * @param pluginName - Plugin name.\n *\n * @returns Never-resolving promise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pluginMethodNoop(target: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", key: " }, { "kind": "Reference", "text": "PropertyKey", "canonicalReference": "!PropertyKey:type" }, { "kind": "Content", "text": ", pluginName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<never>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "pluginName", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "pluginMethodNoop" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#Plugins:member", "docComment": "/**\n * Plugin registry. `@deprecated` Deprecated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Plugins: " }, { "kind": "Reference", "text": "PluginRegistry", "canonicalReference": "obsidian-typings!PluginRegistry:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Plugins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#registerPlugin:member", "docComment": "/**\n * Plugin registration function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerPlugin: " }, { "kind": "Reference", "text": "RegisterPlugin", "canonicalReference": "obsidian-typings!RegisterPlugin:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "registerPlugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorGlobal#removeListener:member(1)", "docComment": "/**\n * Removes a listener for a plugin event.\n *\n * @param pluginName - Plugin name.\n *\n * @param callbackId - Callback ID.\n *\n * @param eventName - Event name.\n *\n * @param callback - Event callback.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener?(pluginName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callbackId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", eventName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Reference", "text": "PluginCallback", "canonicalReference": "obsidian-typings!PluginCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pluginName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callbackId", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CapacitorPlatform:interface", "docComment": "/**\n * Capacitor platform.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CapacitorPlatform " } ], "fileUrlPath": "src/@capacitor__core/internals/CapacitorPlatform.d.ts", "releaseTag": "Public", "name": "CapacitorPlatform", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorPlatform#getPlatform:member(1)", "docComment": "/**\n * Gets the platform name.\n *\n * @returns Platform name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPlatform?(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPlatform" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorPlatform#getPluginHeader:member(1)", "docComment": "/**\n * Gets a plugin header.\n *\n * @param pluginName - Plugin name.\n *\n * @returns Plugin header or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPluginHeader?(pluginName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PluginHeader", "canonicalReference": "obsidian-typings!PluginHeader:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pluginName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPluginHeader" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorPlatform#isNativePlatform:member(1)", "docComment": "/**\n * Checks if the platform is native.\n *\n * @returns Whether the platform is native.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isNativePlatform?(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isNativePlatform" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorPlatform#isPluginAvailable:member(1)", "docComment": "/**\n * Checks if a plugin is available.\n *\n * @param pluginName - Plugin name.\n *\n * @returns Whether the plugin is available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPluginAvailable?(pluginName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pluginName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isPluginAvailable" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorPlatform#name:member", "docComment": "/**\n * Platform name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorPlatform#registerPlugin:member(1)", "docComment": "/**\n * Registers a plugin.\n *\n * @param pluginName - Plugin name.\n *\n * @param jsImplementations - Plugin implementations.\n *\n * @returns Registered plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerPlugin?(pluginName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", jsImplementations: " }, { "kind": "Reference", "text": "PluginImplementations", "canonicalReference": "obsidian-typings!PluginImplementations:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pluginName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "jsImplementations", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "registerPlugin" } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!CapacitorPlatforms_2:var", "docComment": "/**\n * Capacitor platforms instance.\n *\n * @deprecated\n *\n * Deprecated.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "CapacitorPlatforms: " }, { "kind": "Reference", "text": "CapacitorPlatformsGlobal", "canonicalReference": "obsidian-typings!CapacitorPlatformsGlobal:interface" } ], "fileUrlPath": "src/@capacitor__core/internals/vars/CapacitorPlatforms.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "CapacitorPlatforms_2", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CapacitorPlatformsGlobal:interface", "docComment": "/**\n * Capacitor platforms global.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CapacitorPlatformsGlobal " } ], "fileUrlPath": "src/@capacitor__core/internals/CapacitorPlatformsGlobal.d.ts", "releaseTag": "Public", "name": "CapacitorPlatformsGlobal", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorPlatformsGlobal#addPlatform:member(1)", "docComment": "/**\n * Adds a platform.\n *\n * @param name - Platform name.\n *\n * @param platform - Platform instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addPlatform(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", platform: " }, { "kind": "Reference", "text": "CapacitorPlatform", "canonicalReference": "obsidian-typings!CapacitorPlatform:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "platform", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addPlatform" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorPlatformsGlobal#currentPlatform:member", "docComment": "/**\n * Current platform.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "currentPlatform: " }, { "kind": "Reference", "text": "CapacitorPlatform", "canonicalReference": "obsidian-typings!CapacitorPlatform:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "currentPlatform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CapacitorPlatformsGlobal#platforms:member", "docComment": "/**\n * Registered platforms.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "platforms: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CapacitorPlatform", "canonicalReference": "obsidian-typings!CapacitorPlatform:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "platforms", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CapacitorPlatformsGlobal#setPlatform:member(1)", "docComment": "/**\n * Sets the current platform.\n *\n * @param name - Platform name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPlatform(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setPlatform" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CeilFunction:interface", "docComment": "/**\n * Function `Ceil`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CeilFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/CeilFunction.d.ts", "releaseTag": "Public", "name": "CeilFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ChangeByRangeResult:interface", "docComment": "/**\n * Result returned by the callback passed to {@link @codemirror/state#EditorState.changeByRange}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ChangeByRangeResult " } ], "fileUrlPath": "src/@codemirror__state/internals/ChangeByRangeResult.d.ts", "releaseTag": "Public", "name": "ChangeByRangeResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ChangeByRangeResult#changes:member", "docComment": "/**\n * The updated changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changes?: " }, { "kind": "Reference", "text": "ChangeSpec", "canonicalReference": "@codemirror/state!ChangeSpec:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "changes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ChangeByRangeResult#effects:member", "docComment": "/**\n * The updated effects.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "effects?: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "StateEffect", "canonicalReference": "obsidian-typings!~StateEffect" }, { "kind": "Content", "text": "<unknown>[] | " }, { "kind": "Reference", "text": "StateEffect", "canonicalReference": "obsidian-typings!~StateEffect" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "effects", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ChangeByRangeResult#range:member", "docComment": "/**\n * The updated range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "range: " }, { "kind": "Reference", "text": "SelectionRange", "canonicalReference": "obsidian-typings!~SelectionRange" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "range", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ChangeByRangeReturn:interface", "docComment": "/**\n * Result returned from {@link @codemirror/state#EditorState.changeByRange}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ChangeByRangeReturn " } ], "fileUrlPath": "src/@codemirror__state/internals/ChangeByRangeReturn.d.ts", "releaseTag": "Public", "name": "ChangeByRangeReturn", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ChangeByRangeReturn#changes:member", "docComment": "/**\n * The combined change set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changes: " }, { "kind": "Reference", "text": "ChangeSet", "canonicalReference": "obsidian-typings!~ChangeSet" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "changes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ChangeByRangeReturn#effects:member", "docComment": "/**\n * The combined effects.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "effects: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "StateEffect", "canonicalReference": "obsidian-typings!~StateEffect" }, { "kind": "Content", "text": "<unknown>[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "effects", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ChangeByRangeReturn#selection:member", "docComment": "/**\n * The updated selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selection: " }, { "kind": "Reference", "text": "CmEditorSelection", "canonicalReference": "@codemirror/state!EditorSelection:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!changeEnd:function(1)", "docComment": "/**\n * Computes the end position of a change.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeEnd: (change: " }, { "kind": "Reference", "text": "Cm5EditorChange", "canonicalReference": "obsidian-typings!Cm5EditorChange:interface" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" } ], "fileUrlPath": "src/codemirror/internals/vars/changeEnd.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "change", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "changeEnd" }, { "kind": "Variable", "canonicalReference": "obsidian-typings!changeLanguage:var", "docComment": "/**\n * Changes the active language.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeLanguage: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['changeLanguage']" } ], "fileUrlPath": "src/i18next/internals/functions/changeLanguage.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "changeLanguage", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CheckboxPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for checkboxes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CheckboxPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/CheckboxPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "CheckboxPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CheckboxPropertyWidgetComponent#checkboxEl:member", "docComment": "/**\n * The checkbox element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkboxEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "checkboxEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CheckboxPropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CheckboxPropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CheckboxPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'checkbox'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cli:interface", "docComment": "/**\n * Command-line interface handler for Obsidian.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cli " } ], "fileUrlPath": "src/obsidian/internals/cli/Cli.d.ts", "releaseTag": "Public", "name": "Cli", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cli#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getCliConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#formatAsciiTree:member(1)", "docComment": "/**\n * Format tree nodes as an ASCII tree.\n *\n * @param nodes - The tree nodes to format.\n *\n * @param prefix - The indentation prefix for nested nodes.\n *\n * @returns The formatted ASCII tree string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "formatAsciiTree(nodes: " }, { "kind": "Reference", "text": "CliTreeNode", "canonicalReference": "obsidian-typings!CliTreeNode:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", prefix?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "nodes", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "prefix", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ], "name": "formatAsciiTree" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#formatAsciiTreeWithRoot:member(1)", "docComment": "/**\n * Format a root label and child nodes as an ASCII tree.\n *\n * @param root - The root label.\n *\n * @param children - The child tree nodes.\n *\n * @returns The formatted ASCII tree string with root.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "formatAsciiTreeWithRoot(root: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", children: " }, { "kind": "Reference", "text": "CliTreeNode", "canonicalReference": "obsidian-typings!CliTreeNode:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "root", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "children", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "formatAsciiTreeWithRoot" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#formatDiff:member(1)", "docComment": "/**\n * Format two strings as a unified diff.\n *\n * @param oldText - The original text.\n *\n * @param newText - The modified text.\n *\n * @param oldName - The label for the original text.\n *\n * @param newName - The label for the modified text.\n *\n * @returns The formatted diff string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "formatDiff(oldText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", newText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", oldName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", newName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "oldText", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newText", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "oldName", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "newName", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "formatDiff" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#formatTable:member(1)", "docComment": "/**\n * Format data as a table in JSON, CSV, or TSV format.\n *\n * @param headers - Column header names.\n *\n * @param rows - Row data as arrays of strings.\n *\n * @param format - Output format.\n *\n * @returns The formatted table string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "formatTable(headers: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", rows: " }, { "kind": "Content", "text": "string[][]" }, { "kind": "Content", "text": ", format: " }, { "kind": "Content", "text": "'csv' | 'json' | 'tsv'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "headers", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "rows", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "format", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "formatTable" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cli#handlers:member", "docComment": "/**\n * Registered CLI command handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handlers: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CliHandlerEntry", "canonicalReference": "obsidian-typings!CliHandlerEntry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "handlers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#init:member(1)", "docComment": "/**\n * Initialize the CLI handler, registering the global `handleCli` function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "init(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "init" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#registerHandler:member(1)", "docComment": "/**\n * Register a CLI command handler.\n *\n * @param id - The command identifier.\n *\n * @param description - Description shown in help.\n *\n * @param flags - Flags accepted by this command, or `null` for none.\n *\n * @param handler - The handler function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerHandler(\n id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n description: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n flags: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CliFlag", "canonicalReference": "obsidian!CliFlag:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ",\n handler: " }, { "kind": "Content", "text": "(...args: unknown[]) => unknown" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "description", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "flags", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 10 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "name": "registerHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#tryResolveFile:member(1)", "docComment": "/**\n * Try to resolve a file from CLI input parameters.\n *\n * @param params - Parameters for trying to resolve a file.\n *\n * @param requireFile - Whether a file is required (throws if not found when `true`).\n *\n * @returns The resolved file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tryResolveFile(params: " }, { "kind": "Reference", "text": "TryResolveFileParams", "canonicalReference": "obsidian-typings!TryResolveFileParams:interface" }, { "kind": "Content", "text": ", requireFile?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "requireFile", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "tryResolveFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cli#unregisterHandler:member(1)", "docComment": "/**\n * Unregister a CLI command handler.\n *\n * @param id - The command identifier to unregister.\n *\n * @param handler - Optional handler function to match before unregistering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unregisterHandler(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler?: " }, { "kind": "Content", "text": "(...args: unknown[]) => unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "unregisterHandler" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ClickableToken:interface", "docComment": "/**\n * Represents a clickable token in the editor (e.g. link, tag).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ClickableToken " } ], "fileUrlPath": "src/obsidian/internals/ClickableToken.d.ts", "releaseTag": "Public", "name": "ClickableToken", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ClickableToken#end:member", "docComment": "/**\n * End position of the token in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "end: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "end", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ClickableToken#start:member", "docComment": "/**\n * Start position of the token in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "start", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ClickableToken#text:member", "docComment": "/**\n * Text content of the token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ClickableToken#type:member", "docComment": "/**\n * Type of clickable token (e.g. \"internal-link\", \"external-link\", \"tag\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CliHandlerEntry:interface", "docComment": "/**\n * Entry stored in the CLI handlers map.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CliHandlerEntry " } ], "fileUrlPath": "src/obsidian/internals/cli/CliHandlerEntry.d.ts", "releaseTag": "Public", "name": "CliHandlerEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CliHandlerEntry#description:member", "docComment": "/**\n * Description shown in help.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CliHandlerEntry#flags:member", "docComment": "/**\n * Flags accepted by this handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "flags?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CliFlag", "canonicalReference": "obsidian!CliFlag:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "flags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CliHandlerEntry#handler:member(1)", "docComment": "/**\n * The handler function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handler(...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handler" } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!clipboard:var", "docComment": "/**\n * Electron clipboard instance for accessing system clipboard.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clipboard: " }, { "kind": "Reference", "text": "ElectronClipboard", "canonicalReference": "obsidian-typings!ElectronClipboard:interface" } ], "fileUrlPath": "src/electron/internals/vars/clipboard.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "clipboard", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ClipboardManager:interface", "docComment": "/**\n * Manager for clipboard operations in the markdown editor, handling paste, drag, and drop.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ClipboardManager " } ], "fileUrlPath": "src/obsidian/internals/ClipboardManager.d.ts", "releaseTag": "Public", "name": "ClipboardManager", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ClipboardManager#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#getPath:member(1)", "docComment": "/**\n * Get current path of editor view for determining storage location embed.\n *\n * @returns Current editor view path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPath(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#handleDataTransfer:member(1)", "docComment": "/**\n * Process incoming data (image, text, url, html).\n *\n * @param data - The data transfer object.\n *\n * @returns `null` or a promise for async HTML processing.\n *\n * @remark\n *\n * When processing HTML, function will be async.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDataTransfer(data: " }, { "kind": "Reference", "text": "DataTransfer", "canonicalReference": "!DataTransfer:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleDataTransfer" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#handleDragOver:member(1)", "docComment": "/**\n * Handle an incoming drag-over event.\n *\n * @param event - The drag event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDragOver(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleDragOver" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#handleDrop:member(1)", "docComment": "/**\n * Handle an incoming drag-drop event.\n *\n * @param event - The drag event.\n *\n * @returns Whether the drop was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDrop(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleDrop" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#handleDropIntoEditor:member(1)", "docComment": "/**\n * Process a drop event into the editor.\n *\n * @param event - The drag event.\n *\n * @returns The inserted text, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDropIntoEditor(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleDropIntoEditor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#handlePaste:member(1)", "docComment": "/**\n * Handle an incoming paste event.\n *\n * @param event - The clipboard event.\n *\n * @returns Whether the paste was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handlePaste(event: " }, { "kind": "Reference", "text": "ClipboardEvent", "canonicalReference": "!ClipboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handlePaste" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ClipboardManager#info:member", "docComment": "/**\n * Reference to the Editor View.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "info: " }, { "kind": "Reference", "text": "MarkdownView", "canonicalReference": "obsidian!MarkdownView:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "info", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#insertAttachmentEmbed:member(1)", "docComment": "/**\n * Insert single file as embed into the editor.\n *\n * @param file - File to embed.\n *\n * @param replace - Whether to replace the current selection.\n *\n * @returns A promise that resolves when the embed is inserted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertAttachmentEmbed(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", replace: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "replace", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "insertAttachmentEmbed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#insertFiles:member(1)", "docComment": "/**\n * Insert files from drop-event into the editor.\n *\n * @param importedAttachments - Attachments to insert.\n *\n * @returns A promise that resolves when all files are inserted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertFiles(importedAttachments: " }, { "kind": "Reference", "text": "ImportedAttachment", "canonicalReference": "obsidian-typings!ImportedAttachment:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "importedAttachments", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "insertFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ClipboardManager#saveAttachment:member(1)", "docComment": "/**\n * Save an attachment of specified name and extension to the vault.\n *\n * @param name - Attachment file name.\n *\n * @param extension - File extension.\n *\n * @param data - Binary data of the attachment.\n *\n * @param replace - Whether to replace the current selection.\n *\n * @returns A promise that resolves when the attachment is saved.\n *\n * @remark\n *\n * Invokes insertAttachmentEmbed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveAttachment(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", data: " }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": ", replace: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "extension", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "replace", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "saveAttachment" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CliTreeNode:interface", "docComment": "/**\n * A node in a CLI ASCII tree.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CliTreeNode " } ], "fileUrlPath": "src/obsidian/internals/cli/CliTreeNode.d.ts", "releaseTag": "Public", "name": "CliTreeNode", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CliTreeNode#children:member", "docComment": "/**\n * Child nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "children?: " }, { "kind": "Reference", "text": "CliTreeNode", "canonicalReference": "obsidian-typings!CliTreeNode:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CliTreeNode#label:member", "docComment": "/**\n * Label text for this tree node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CloneViewportParams:interface", "docComment": "/**\n * Parameters for cloning a page viewport with overrides.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CloneViewportParams " } ], "fileUrlPath": "src/pdfjs-dist/internals/CloneViewportParams.d.ts", "releaseTag": "Public", "name": "CloneViewportParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CloneViewportParams#dontFlip:member", "docComment": "/**\n * Whether to flip the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dontFlip?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "dontFlip", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CloneViewportParams#offsetX:member", "docComment": "/**\n * Horizontal offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offsetX?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "offsetX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CloneViewportParams#offsetY:member", "docComment": "/**\n * Vertical offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offsetY?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "offsetY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CloneViewportParams#rotation:member", "docComment": "/**\n * Rotation angle in degrees.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotation?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rotation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CloneViewportParams#scale:member", "docComment": "/**\n * Scale factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CloseableComponent:interface", "docComment": "/**\n * A closeable component that can get dismissed via the Android 'back' button.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CloseableComponent " } ], "fileUrlPath": "src/obsidian/internals/CloseableComponent.d.ts", "releaseTag": "Public", "name": "CloseableComponent", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CloseableComponent#close:member(1)", "docComment": "/**\n * Close the component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "close" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5BookmarkOptions:interface", "docComment": "/**\n * Options for creating a bookmark in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5BookmarkOptions " } ], "fileUrlPath": "src/codemirror/internals/Cm5BookmarkOptions.d.ts", "releaseTag": "Public", "name": "Cm5BookmarkOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5BookmarkOptions#handleMouseEvents:member", "docComment": "/**\n * Whether CodeMirror handles mouse events on the bookmark widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleMouseEvents?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "handleMouseEvents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5BookmarkOptions#insertLeft:member", "docComment": "/**\n * Whether text typed at the bookmark position goes to the left of it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertLeft?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "insertLeft", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5BookmarkOptions#shared:member", "docComment": "/**\n * Whether the bookmark appears in all linked documents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shared?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "shared", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5BookmarkOptions#widget:member", "docComment": "/**\n * A DOM node to display at the bookmark position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "widget?: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "widget", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!Cm5CoordsMode:type", "docComment": "/**\n * Coordinate system mode for CodeMirror 5 position calculations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Cm5CoordsMode = " }, { "kind": "Content", "text": "'div' | 'local' | 'page' | 'window'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/Cm5CoordsMode.d.ts", "releaseTag": "Public", "name": "Cm5CoordsMode", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5Editor:interface", "docComment": "/**\n * A CodeMirror 5 editor instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5Editor extends " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/codemirror/internals/Cm5Editor.d.ts", "releaseTag": "Public", "name": "Cm5Editor", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#addKeyMap:member(1)", "docComment": "/**\n * Adds a key map to the editor.\n *\n * @param map - The key map to add.\n *\n * @param bottom - Whether to add the map at the bottom of the stack.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addKeyMap(map: " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", bottom?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "map", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "bottom", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ], "name": "addKeyMap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#addLineClass:member(1)", "docComment": "/**\n * Set a CSS class name for the given line.\n *\n * @param line - The line number or handle.\n *\n * @param where - Which element to apply the class to (\"text\", \"background\", or \"wrap\").\n *\n * @param className - The CSS class name.\n *\n * @returns The line handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addLineClass(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ", where: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", className: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "className", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false } ], "name": "addLineClass" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#addLineWidget:member(1)", "docComment": "/**\n * Adds a line widget below the given line.\n *\n * @param line - The line number or handle.\n *\n * @param node - The DOM node to display.\n *\n * @param options - Optional widget configuration.\n *\n * @returns The created line widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addLineWidget(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ", node: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5LineWidgetOptions", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5LineWidget", "canonicalReference": "obsidian-typings!Cm5LineWidget:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "addLineWidget" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#addOverlay:member(1)", "docComment": "/**\n * Adds a mode overlay to the editor.\n *\n * @param mode - The mode or mode name.\n *\n * @param options - Optional overlay options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addOverlay(mode: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5OverlayOptions", "canonicalReference": "obsidian-typings!Cm5OverlayOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "addOverlay" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#addSelection:member(1)", "docComment": "/**\n * Adds a new selection to the existing set of selections.\n *\n * @param anchor - The anchor position.\n *\n * @param head - The optional head position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSelection(anchor: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", head?: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "anchor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "head", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "addSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#addWidget:member(1)", "docComment": "/**\n * Puts an absolutely positioned DOM node into the editor.\n *\n * @param pos - The position to place the widget at.\n *\n * @param node - The DOM node.\n *\n * @param scrollIntoView - Whether to scroll the widget into view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addWidget(pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", node: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", scrollIntoView: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "scrollIntoView", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "addWidget" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#charCoords:member(1)", "docComment": "/**\n * Returns the coordinates for a character position.\n *\n * @param pos - The character position.\n *\n * @param mode - The coordinate system to use.\n *\n * @returns An object with `left`, `right`, `top`, and `bottom` properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "charCoords(pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", mode?: " }, { "kind": "Reference", "text": "Cm5CoordsMode", "canonicalReference": "obsidian-typings!Cm5CoordsMode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5EditorCharCoords", "canonicalReference": "obsidian-typings!Cm5EditorCharCoords:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "charCoords" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#clearGutter:member(1)", "docComment": "/**\n * Remove all gutter markers in the gutter with the given ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearGutter(gutterID: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "gutterID", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "clearGutter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#coordsChar:member(1)", "docComment": "/**\n * Returns the position corresponding to the given coordinates.\n *\n * @param coords - The coordinates with `left` and `top` properties.\n *\n * @param mode - The coordinate system used.\n *\n * @returns The corresponding position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "coordsChar(coords: " }, { "kind": "Reference", "text": "Cm5EditorCoordsCharInput", "canonicalReference": "obsidian-typings!Cm5EditorCoordsCharInput:interface" }, { "kind": "Content", "text": ", mode?: " }, { "kind": "Reference", "text": "Cm5CoordsMode", "canonicalReference": "obsidian-typings!Cm5CoordsMode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "coords", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "coordsChar" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#cursorCoords:member(1)", "docComment": "/**\n * Returns the coordinates of the cursor.\n *\n * @param where - Whether to return the start or end of the selection.\n *\n * @param mode - The coordinate system to use.\n *\n * @returns An object with `left`, `top`, and `bottom` properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursorCoords(where?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", mode?: " }, { "kind": "Reference", "text": "Cm5CoordsMode", "canonicalReference": "obsidian-typings!Cm5CoordsMode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5EditorCursorCoords", "canonicalReference": "obsidian-typings!Cm5EditorCursorCoords:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ], "name": "cursorCoords" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#defaultCharWidth:member(1)", "docComment": "/**\n * Returns the default character width.\n *\n * @returns The default character width in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultCharWidth(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "defaultCharWidth" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#defaultTextHeight:member(1)", "docComment": "/**\n * Returns the default text height.\n *\n * @returns The default text height in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultTextHeight(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "defaultTextHeight" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Editor#display:member", "docComment": "/**\n * The display object containing the wrapper element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "display: " }, { "kind": "Reference", "text": "Cm5EditorDisplay", "canonicalReference": "obsidian-typings!Cm5EditorDisplay:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "display", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#endOperation:member(1)", "docComment": "/**\n * Ends a buffered operation started with startOperation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "endOperation(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "endOperation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#execCommand:member(1)", "docComment": "/**\n * Executes a named command.\n *\n * @param name - The command name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "execCommand(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "execCommand" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#extendSelection:member(1)", "docComment": "/**\n * Moves the head of the selection while leaving the anchor in place.\n *\n * @param from - The position to extend from.\n *\n * @param to - Optional end of region to select.\n *\n * @param options - Optional selection options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extendSelection(from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", to?: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5SelectionOptions", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "extendSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#extendSelections:member(1)", "docComment": "/**\n * Like extendSelection, but acts on all selections at once.\n *\n * @param heads - The new head positions.\n *\n * @param options - Optional selection options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extendSelections(heads: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5SelectionOptions", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "heads", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ], "name": "extendSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#extendSelectionsBy:member(1)", "docComment": "/**\n * Applies a function to all selections and calls extendSelections on the result.\n *\n * @param f - The function to apply to each range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extendSelectionsBy(f: " }, { "kind": "Content", "text": "(range: " }, { "kind": "Reference", "text": "Cm5Range", "canonicalReference": "obsidian-typings!Cm5Range:interface" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "name": "extendSelectionsBy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#findPosH:member(1)", "docComment": "/**\n * Finds the target position for horizontal cursor motion.\n *\n * @param start - The starting position.\n *\n * @param amount - The number of units to move (may be negative).\n *\n * @param unit - The unit (\"char\", \"column\", or \"word\").\n *\n * @param visually - Whether motion should be visual rather than logical.\n *\n * @returns The target position, with `hitSide` set if the edge was reached.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findPosH(start: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", amount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", unit: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", visually: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5FindPosResult", "canonicalReference": "obsidian-typings!Cm5FindPosResult:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "start", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "unit", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "visually", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "findPosH" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#findPosV:member(1)", "docComment": "/**\n * Finds the target position for vertical cursor motion.\n *\n * @param start - The starting position.\n *\n * @param amount - The number of units to move.\n *\n * @param unit - The unit (\"line\" or \"page\").\n *\n * @returns The target position, with `hitSide` set if the edge was reached.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findPosV(start: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", amount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", unit: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5FindPosResult", "canonicalReference": "obsidian-typings!Cm5FindPosResult:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "start", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "unit", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "findPosV" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#findWordAt:member(1)", "docComment": "/**\n * Returns the start and end of the word at the given position.\n *\n * @param pos - The position.\n *\n * @returns The range of the word.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findWordAt(pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Range", "canonicalReference": "obsidian-typings!Cm5Range:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "findWordAt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#focus:member(1)", "docComment": "/**\n * Gives focus to the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getDoc:member(1)", "docComment": "/**\n * Gets the associated document.\n *\n * @returns The document instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDoc(): " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDoc" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getExtending:member(1)", "docComment": "/**\n * Get the value of the 'extending' flag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getExtending(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getExtending" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getGutterElement:member(1)", "docComment": "/**\n * Returns the gutter element.\n *\n * @returns The gutter DOM element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGutterElement(): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getGutterElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getInputField:member(1)", "docComment": "/**\n * Returns the input field element.\n *\n * @returns The input field DOM element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getInputField(): " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "HTMLTextAreaElement", "canonicalReference": "!HTMLTextAreaElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getInputField" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getLineTokens:member(1)", "docComment": "/**\n * Retrieves a list of all tokens on the given line.\n *\n * @param line - The line number.\n *\n * @param precise - Whether to use a more precise (but slower) algorithm.\n *\n * @returns An array of tokens.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLineTokens(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", precise?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Token", "canonicalReference": "obsidian-typings!Cm5Token:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "precise", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getLineTokens" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getModeAt:member(1)", "docComment": "/**\n * Gets the inner mode at a given position.\n *\n * @param pos - The position.\n *\n * @returns The mode at that position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getModeAt(pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getModeAt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getOption:member(1)", "docComment": "/**\n * Gets the value of an option.\n *\n * @param option - The option name.\n *\n * @returns The option value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOption(option: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "option", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getOption" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getScrollerElement:member(1)", "docComment": "/**\n * Returns the scroller element.\n *\n * @returns The scroller DOM element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getScrollerElement(): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getScrollerElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getScrollInfo:member(1)", "docComment": "/**\n * Returns scroll position and dimensions.\n *\n * @returns The scroll info object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getScrollInfo(): " }, { "kind": "Reference", "text": "Cm5ScrollInfo", "canonicalReference": "obsidian-typings!Cm5ScrollInfo:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getScrollInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getStateAfter:member(1)", "docComment": "/**\n * Returns the mode's parser state at the end of the given line number.\n *\n * @param line - The line number.\n *\n * @returns The parser state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getStateAfter(line?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getStateAfter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getTokenAt:member(1)", "docComment": "/**\n * Retrieves information about the token at the given position.\n *\n * @param pos - The position.\n *\n * @param precise - Whether to use a more precise algorithm.\n *\n * @returns The token information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTokenAt(pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", precise?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Token", "canonicalReference": "obsidian-typings!Cm5Token:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "precise", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getTokenAt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getTokenTypeAt:member(1)", "docComment": "/**\n * Returns the token type at the given position.\n *\n * @param pos - The position.\n *\n * @returns The token type string, or `null` for unstyled tokens.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTokenTypeAt(pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getTokenTypeAt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getViewport:member(1)", "docComment": "/**\n * Returns the start and end of the currently rendered part of the document.\n *\n * @returns An object with `from` and `to` properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewport(): " }, { "kind": "Reference", "text": "Cm5Viewport", "canonicalReference": "obsidian-typings!Cm5Viewport:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewport" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#getWrapperElement:member(1)", "docComment": "/**\n * Returns the wrapper element.\n *\n * @returns The wrapper DOM element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getWrapperElement(): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWrapperElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#hasFocus:member(1)", "docComment": "/**\n * Tells whether the editor currently has focus.\n *\n * @returns `true` if the editor has focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasFocus(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hasFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#heightAtLine:member(1)", "docComment": "/**\n * Computes the height of the top of a line.\n *\n * @param line - The line number or handle.\n *\n * @param mode - The coordinate system.\n *\n * @param includeWidgets - Whether to include line widgets.\n *\n * @returns The height in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "heightAtLine(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ", mode?: " }, { "kind": "Reference", "text": "Cm5CoordsMode", "canonicalReference": "obsidian-typings!Cm5CoordsMode:type" }, { "kind": "Content", "text": ", includeWidgets?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "includeWidgets", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "heightAtLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#indentLine:member(1)", "docComment": "/**\n * Adjusts the indentation of the given line.\n *\n * @param line - The line number.\n *\n * @param dir - The indentation direction or mode.\n *\n * @param aggressive - Whether to aggressively indent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentLine(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", dir?: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ", aggressive?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "dir", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "aggressive", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "indentLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#indentSelection:member(1)", "docComment": "/**\n * Indents the current selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentSelection(how: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "how", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "indentSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#isReadOnly:member(1)", "docComment": "/**\n * Tells you whether the editor's content can be edited by the user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isReadOnly(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isReadOnly" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#lineAtHeight:member(1)", "docComment": "/**\n * Computes the line at the given pixel height.\n *\n * @param height - The pixel height.\n *\n * @param mode - The coordinate system.\n *\n * @returns The line number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineAtHeight(height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", mode?: " }, { "kind": "Reference", "text": "Cm5CoordsMode", "canonicalReference": "obsidian-typings!Cm5CoordsMode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "lineAtHeight" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#lineInfo:member(1)", "docComment": "/**\n * Returns information about the given line.\n *\n * @param line - The line number or handle.\n *\n * @returns An object with line info properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineInfo(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5LineInfo", "canonicalReference": "obsidian-typings!Cm5LineInfo:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "lineInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#listSelections:member(1)", "docComment": "/**\n * Retrieves a list of all current selections.\n *\n * @returns An array of selection ranges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "listSelections(): " }, { "kind": "Reference", "text": "Cm5Range", "canonicalReference": "obsidian-typings!Cm5Range:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "listSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#off:member(1)", "docComment": "/**\n * Removes an event listener.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(eventName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#on:member(1)", "docComment": "/**\n * Registers an event listener.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(eventName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#operation:member(1)", "docComment": "/**\n * Buffers all changes inside the function and only updates after it returns.\n *\n * @param fn - The function to execute.\n *\n * @returns The return value of the function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "operation<T>(fn: " }, { "kind": "Content", "text": "() => T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "operation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#phrase:member(1)", "docComment": "/**\n * Translates a string through the phrases option for i18n.\n *\n * @param text - The text to translate.\n *\n * @returns The translated text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "phrase(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "phrase" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#refresh:member(1)", "docComment": "/**\n * Refreshes the editor display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "refresh(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "refresh" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#removeKeyMap:member(1)", "docComment": "/**\n * Removes a key map from the editor.\n *\n * @param map - The key map to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeKeyMap(map: " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "map", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "removeKeyMap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#removeLineClass:member(1)", "docComment": "/**\n * Remove a CSS class from a line.\n *\n * @param line - The line number or handle.\n *\n * @param where - Which element (\"text\", \"background\", or \"wrap\").\n *\n * @param className - The class to remove (omit to remove all).\n *\n * @returns The line handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeLineClass(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ", where: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", className?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "className", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "removeLineClass" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#removeLineWidget:member(1)", "docComment": "/**\n * Removes a line widget.\n *\n * @param widget - The widget to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeLineWidget(widget: " }, { "kind": "Reference", "text": "Cm5LineWidget", "canonicalReference": "obsidian-typings!Cm5LineWidget:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "widget", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeLineWidget" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#removeOverlay:member(1)", "docComment": "/**\n * Removes a mode overlay from the editor.\n *\n * @param mode - The mode or mode name to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeOverlay(mode: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeOverlay" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#replaceSelections:member(1)", "docComment": "/**\n * Replaces the content of the selections with the given strings.\n *\n * @param replacements - The replacement strings.\n *\n * @param collapse - How to collapse the selection after replacement.\n *\n * @param origin - Optional origin string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceSelections(replacements: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", collapse?: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ", origin?: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replacements", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "collapse", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "replaceSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#scrollIntoView:member(1)", "docComment": "/**\n * Scrolls the editor to the given position.\n *\n * @param pos - The position or rectangle to scroll into view.\n *\n * @param margin - Optional margin in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollIntoView(pos: " }, { "kind": "Reference", "text": "Cm5EditorScrollRect", "canonicalReference": "obsidian-typings!Cm5EditorScrollRect:interface" }, { "kind": "Content", "text": " | null | " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", margin?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false }, { "parameterName": "margin", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "scrollIntoView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#scrollTo:member(1)", "docComment": "/**\n * Scrolls the editor to the given coordinates.\n *\n * @param x - The horizontal scroll position.\n *\n * @param y - The vertical scroll position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollTo(x?: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ", y?: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "scrollTo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#setExtending:member(1)", "docComment": "/**\n * Sets or clears the 'extending' flag.\n *\n * @param value - Whether to enable extending.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setExtending(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setExtending" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#setGutterMarker:member(1)", "docComment": "/**\n * Sets the gutter marker for the given gutter.\n *\n * @param line - The line number or handle.\n *\n * @param gutterID - The gutter's CSS class identifier.\n *\n * @param value - The marker element, or `null` to clear.\n *\n * @returns The line handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setGutterMarker(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ", gutterID: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "gutterID", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "isOptional": false } ], "name": "setGutterMarker" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#setOption:member(1)", "docComment": "/**\n * Sets the value of an option.\n *\n * @param option - The option name.\n *\n * @param value - The new value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOption(option: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "option", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setOption" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#setSelections:member(1)", "docComment": "/**\n * Sets a new set of selections.\n *\n * @param ranges - The selection ranges.\n *\n * @param primary - The index of the primary selection.\n *\n * @param options - Optional selection options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSelections(ranges: " }, { "kind": "Reference", "text": "Cm5SelectionRange", "canonicalReference": "obsidian-typings!Cm5SelectionRange:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", primary?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5SelectionOptions", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ranges", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "primary", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "setSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#setSize:member(1)", "docComment": "/**\n * Sets the editor size.\n *\n * @param width - The width (pixels or CSS unit).\n *\n * @param height - The height (pixels or CSS unit).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSize(width: " }, { "kind": "Content", "text": "null | number | string" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "null | number | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setSize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#startOperation:member(1)", "docComment": "/**\n * Starts a buffered operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startOperation(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "startOperation" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Editor#state:member", "docComment": "/**\n * The editor state object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Reference", "text": "Cm5EditorState", "canonicalReference": "obsidian-typings!Cm5EditorState:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#swapDoc:member(1)", "docComment": "/**\n * Attaches a new document to the editor.\n *\n * @param doc - The new document.\n *\n * @returns The old document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "swapDoc(doc: " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "doc", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "swapDoc" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Editor#toggleOverwrite:member(1)", "docComment": "/**\n * Switches between overwrite and normal insert mode.\n *\n * @param value - If given, sets overwrite mode to this value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleOverwrite(value?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "toggleOverwrite" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorChange:interface", "docComment": "/**\n * Represents a change made to a CodeMirror 5 document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorChange " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorChange.d.ts", "releaseTag": "Public", "name": "Cm5EditorChange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorChange#from:member", "docComment": "/**\n * The start position of the change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorChange#origin:member", "docComment": "/**\n * The origin of the change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorChange#removed:member", "docComment": "/**\n * The text that was removed by the change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removed?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "removed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorChange#text:member", "docComment": "/**\n * The new text that was inserted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorChange#to:member", "docComment": "/**\n * The end position of the change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorChangeCancellable:interface", "docComment": "/**\n * A cancellable editor change object in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorChangeCancellable extends " }, { "kind": "Reference", "text": "Cm5EditorChange", "canonicalReference": "obsidian-typings!Cm5EditorChange:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorChangeCancellable.d.ts", "releaseTag": "Public", "name": "Cm5EditorChangeCancellable", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5EditorChangeCancellable#cancel:member(1)", "docComment": "/**\n * Cancels the change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cancel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5EditorChangeCancellable#update:member(1)", "docComment": "/**\n * Modifies the change. All arguments are optional.\n *\n * @param from - New start position.\n *\n * @param to - New end position.\n *\n * @param text - New replacement text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update?(from?: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", to?: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", text?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "update" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorCharCoords:interface", "docComment": "/**\n * Coordinates returned by charCoords.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorCharCoords " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorCharCoords.d.ts", "releaseTag": "Public", "name": "Cm5EditorCharCoords", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCharCoords#bottom:member", "docComment": "/**\n * The bottom coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCharCoords#left:member", "docComment": "/**\n * The left coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCharCoords#right:member", "docComment": "/**\n * The right coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "right: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCharCoords#top:member", "docComment": "/**\n * The top coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration:interface", "docComment": "/**\n * Configuration options for a CodeMirror 5 editor instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorConfiguration " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorConfiguration.d.ts", "releaseTag": "Public", "name": "Cm5EditorConfiguration", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration:index(1)", "docComment": "/**\n * Additional configuration options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#addModeClass:member", "docComment": "/**\n * Whether to add an extra CSS class indicating the inner mode to each token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addModeClass?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "addModeClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#allowDropFileTypes:member", "docComment": "/**\n * When set, only files whose MIME type is in this array can be dropped.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowDropFileTypes?: " }, { "kind": "Content", "text": "null | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "allowDropFileTypes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#autocapitalize:member", "docComment": "/**\n * Whether to enable autocapitalize on the input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autocapitalize?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autocapitalize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#autocorrect:member", "docComment": "/**\n * Whether to enable autocorrect on the input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autocorrect?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autocorrect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#autofocus:member", "docComment": "/**\n * Whether to auto-focus on initialization.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autofocus?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autofocus", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#configureMouse:member(1)", "docComment": "/**\n * Allows you to configure the behavior of mouse selection and dragging.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "configureMouse?(cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ", repeat: " }, { "kind": "Content", "text": "'double' | 'single' | 'triple'" }, { "kind": "Content", "text": ", event: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5MouseSelectionConfiguration", "canonicalReference": "obsidian-typings!Cm5MouseSelectionConfiguration:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "repeat", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "configureMouse" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#coverGutterNextToScrollbar:member", "docComment": "/**\n * Whether the gutter will be covered when next to a scrollbar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "coverGutterNextToScrollbar?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "coverGutterNextToScrollbar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#cursorBlinkRate:member", "docComment": "/**\n * Half-period in milliseconds used for cursor blinking.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursorBlinkRate?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cursorBlinkRate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#cursorHeight:member", "docComment": "/**\n * Determines the height of the cursor (0 to 1).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursorHeight?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cursorHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#cursorScrollMargin:member", "docComment": "/**\n * Extra space above and below the cursor when approaching the visible edge.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursorScrollMargin?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cursorScrollMargin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#direction:member", "docComment": "/**\n * Flips overall layout direction (\"ltr\" or \"rtl\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "direction?: " }, { "kind": "Content", "text": "'ltr' | 'rtl'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "direction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#dragDrop:member", "docComment": "/**\n * Controls whether drag-and-drop is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragDrop?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "dragDrop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#electricChars:member", "docComment": "/**\n * Whether to re-indent when a character is typed that might change indentation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "electricChars?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "electricChars", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#extraKeys:member", "docComment": "/**\n * Can be used to specify extra keybindings for the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extraKeys?: " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": " | null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "extraKeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#firstLineNumber:member", "docComment": "/**\n * At which number to start counting lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "firstLineNumber?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "firstLineNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#fixedGutter:member", "docComment": "/**\n * Whether the gutter stays fixed during horizontal scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fixedGutter?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fixedGutter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#flattenSpans:member", "docComment": "/**\n * Whether to combine adjacent tokens with the same class into a single span.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "flattenSpans?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "flattenSpans", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#gutters:member", "docComment": "/**\n * An array of CSS class names for gutters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gutters?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Cm5GutterConfig", "canonicalReference": "obsidian-typings!Cm5GutterConfig:interface" }, { "kind": "Content", "text": " | string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "gutters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#historyEventDelay:member", "docComment": "/**\n * The period of inactivity (ms) before a new history event is started.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "historyEventDelay?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "historyEventDelay", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#indentUnit:member", "docComment": "/**\n * The number of spaces a block should be indented.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentUnit?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "indentUnit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#indentWithTabs:member", "docComment": "/**\n * Whether to indent with tabs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentWithTabs?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "indentWithTabs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#inputStyle:member", "docComment": "/**\n * Selects the input model (\"textarea\" or \"contenteditable\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputStyle?: " }, { "kind": "Reference", "text": "Cm5InputStyle", "canonicalReference": "obsidian-typings!Cm5InputStyle:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inputStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#keyMap:member", "docComment": "/**\n * Configures the keymap to use.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyMap?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "keyMap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#lineNumberFormatter:member(1)", "docComment": "/**\n * A function to format line numbers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineNumberFormatter?(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "lineNumberFormatter" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#lineNumbers:member", "docComment": "/**\n * Whether to show line numbers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineNumbers?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lineNumbers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#lineSeparator:member", "docComment": "/**\n * Explicitly set the line separator for the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineSeparator?: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lineSeparator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#lineWiseCopyCut:member", "docComment": "/**\n * Whether to enable line-wise copy/cut when there is no selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineWiseCopyCut?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lineWiseCopyCut", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#lineWrapping:member", "docComment": "/**\n * Whether to enable line wrapping.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineWrapping?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lineWrapping", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#maxHighlightLength:member", "docComment": "/**\n * Position beyond which highlighting gives up.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxHighlightLength?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxHighlightLength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#mode:member", "docComment": "/**\n * The mode specification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode?: " }, { "kind": "Reference", "text": "Cm5ModeSpec", "canonicalReference": "obsidian-typings!Cm5ModeSpec:type" }, { "kind": "Content", "text": "<unknown> | null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#onDragEvent:member(1)", "docComment": "/**\n * Deprecated drag event handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDragEvent?(instance: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ", event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "instance", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onDragEvent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#onKeyEvent:member(1)", "docComment": "/**\n * Deprecated key event handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyEvent?(instance: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ", event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "instance", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onKeyEvent" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#pasteLinesPerSelection:member", "docComment": "/**\n * Whether to paste one line per selection when counts match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pasteLinesPerSelection?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pasteLinesPerSelection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#phrases:member", "docComment": "/**\n * An object mapping strings to translations for i18n.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "phrases?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "phrases", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#pollInterval:member", "docComment": "/**\n * How quickly (ms) CodeMirror should poll its input for changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pollInterval?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pollInterval", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#readOnly:member", "docComment": "/**\n * Whether the editor is read-only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readOnly?: " }, { "kind": "Content", "text": "'nocursor' | boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "readOnly", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#resetSelectionOnContextMenu:member", "docComment": "/**\n * Controls whether the context menu resets the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resetSelectionOnContextMenu?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "resetSelectionOnContextMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#rtlMoveVisually:member", "docComment": "/**\n * Whether horizontal cursor movement through RTL text is visual.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rtlMoveVisually?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rtlMoveVisually", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#screenReaderLabel:member", "docComment": "/**\n * A label read by screen readers when the editor is focused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "screenReaderLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "screenReaderLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#scrollbarStyle:member", "docComment": "/**\n * Chooses a scrollbar implementation (\"native\" or \"null\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollbarStyle?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scrollbarStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#selectionsMayTouch:member", "docComment": "/**\n * Whether multiple selections are joined when they touch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectionsMayTouch?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selectionsMayTouch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#showCursorWhenSelecting:member", "docComment": "/**\n * Whether the cursor should be drawn when a selection is active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showCursorWhenSelecting?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showCursorWhenSelecting", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#smartIndent:member", "docComment": "/**\n * Whether to use context-sensitive indentation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "smartIndent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "smartIndent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#specialCharPlaceholder:member(1)", "docComment": "/**\n * A function that produces a DOM node for special characters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "specialCharPlaceholder?(char: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "char", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "specialCharPlaceholder" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#specialChars:member", "docComment": "/**\n * A regular expression for characters that should be replaced by a placeholder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "specialChars?: " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "specialChars", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#spellcheck:member", "docComment": "/**\n * Whether to enable spellcheck on the input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "spellcheck?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "spellcheck", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#tabindex:member", "docComment": "/**\n * The tab index to assign to the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabindex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tabindex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#tabSize:member", "docComment": "/**\n * The tab size in spaces.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabSize?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tabSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#theme:member", "docComment": "/**\n * The theme to style the editor with.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "theme?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "theme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#undoDepth:member", "docComment": "/**\n * The maximum number of undo levels stored.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undoDepth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "undoDepth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#value:member", "docComment": "/**\n * The starting value of the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value?: " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#viewportMargin:member", "docComment": "/**\n * Specifies the amount of lines rendered above and below the visible area.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewportMargin?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "viewportMargin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#workDelay:member", "docComment": "/**\n * How long (ms) the highlighting thread works before sleeping.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workDelay?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "workDelay", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration#workTime:member", "docComment": "/**\n * How long (ms) the highlighting thread sleeps between work periods.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workTime?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "workTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorCoordsCharInput:interface", "docComment": "/**\n * Coordinates used as input for coordsChar.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorCoordsCharInput " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorCoordsCharInput.d.ts", "releaseTag": "Public", "name": "Cm5EditorCoordsCharInput", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCoordsCharInput#left:member", "docComment": "/**\n * The left coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCoordsCharInput#top:member", "docComment": "/**\n * The top coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorCursorCoords:interface", "docComment": "/**\n * Coordinates returned by cursorCoords.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorCursorCoords " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorCursorCoords.d.ts", "releaseTag": "Public", "name": "Cm5EditorCursorCoords", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCursorCoords#bottom:member", "docComment": "/**\n * The bottom coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCursorCoords#left:member", "docComment": "/**\n * The left coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorCursorCoords#top:member", "docComment": "/**\n * The top coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorDisplay:interface", "docComment": "/**\n * The display state of a CM5 editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorDisplay " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorDisplay.d.ts", "releaseTag": "Public", "name": "Cm5EditorDisplay", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorDisplay#wrapper:member", "docComment": "/**\n * The wrapper HTML element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wrapper: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wrapper", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorScrollRect:interface", "docComment": "/**\n * A rectangle used for scrolling into view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorScrollRect " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorScrollRect.d.ts", "releaseTag": "Public", "name": "Cm5EditorScrollRect", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorScrollRect#bottom:member", "docComment": "/**\n * The bottom coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorScrollRect#left:member", "docComment": "/**\n * The left coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorScrollRect#right:member", "docComment": "/**\n * The right coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "right: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorScrollRect#top:member", "docComment": "/**\n * The top coordinate in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorSelectionChange:interface", "docComment": "/**\n * A selection change event object in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorSelectionChange " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorSelectionChange.d.ts", "releaseTag": "Public", "name": "Cm5EditorSelectionChange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorSelectionChange#origin:member", "docComment": "/**\n * The origin of the selection change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorSelectionChange#ranges:member", "docComment": "/**\n * The new selection ranges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ranges: " }, { "kind": "Reference", "text": "Cm5Range", "canonicalReference": "obsidian-typings!Cm5Range:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ranges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5EditorSelectionChange#update:member(1)", "docComment": "/**\n * Modifies the ranges for this selection change.\n *\n * @param ranges - The new selection ranges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(ranges: " }, { "kind": "Reference", "text": "Cm5Range", "canonicalReference": "obsidian-typings!Cm5Range:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ranges", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "update" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5EditorState:interface", "docComment": "/**\n * The state of a CM5 editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5EditorState " } ], "fileUrlPath": "src/codemirror/internals/Cm5EditorState.d.ts", "releaseTag": "Public", "name": "Cm5EditorState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5EditorState#vim:member", "docComment": "/**\n * The Vim mode state, if Vim mode is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vim?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "vim", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5FindPosResult:interface", "docComment": "/**\n * Result of a cursor position search in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5FindPosResult " } ], "fileUrlPath": "src/codemirror/internals/Cm5FindPosResult.d.ts", "releaseTag": "Public", "name": "Cm5FindPosResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5FindPosResult#ch:member", "docComment": "/**\n * Character position within the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ch: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5FindPosResult#hitSide:member", "docComment": "/**\n * Whether the edge of the document was reached.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hitSide?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hitSide", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5FindPosResult#line:member", "docComment": "/**\n * Line number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "line", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5GutterConfig:interface", "docComment": "/**\n * Configuration for a gutter in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5GutterConfig " } ], "fileUrlPath": "src/codemirror/internals/Cm5GutterConfig.d.ts", "releaseTag": "Public", "name": "Cm5GutterConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5GutterConfig#className:member", "docComment": "/**\n * The CSS class name for the gutter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "className: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "className", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5GutterConfig#style:member", "docComment": "/**\n * Optional inline CSS style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "style?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "style", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5InnerModeResult:interface", "docComment": "/**\n * Result of CodeMirror 5's innerMode function.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5InnerModeResult " } ], "fileUrlPath": "src/codemirror/internals/Cm5InnerModeResult.d.ts", "releaseTag": "Public", "name": "Cm5InnerModeResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5InnerModeResult#mode:member", "docComment": "/**\n * The inner mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode: " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5InnerModeResult#state:member", "docComment": "/**\n * The inner mode's state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!Cm5InputStyle:type", "docComment": "/**\n * Input style for CodeMirror 5 editors.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Cm5InputStyle = " }, { "kind": "Content", "text": "'contenteditable' | 'textarea'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/Cm5InputStyle.d.ts", "releaseTag": "Public", "name": "Cm5InputStyle", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface", "docComment": "/**\n * A CodeMirror 5 key map, mapping key names to actions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5KeyMap " } ], "fileUrlPath": "src/codemirror/internals/Cm5KeyMap.d.ts", "releaseTag": "Public", "name": "Cm5KeyMap", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!Cm5KeyMap:index(1)", "docComment": "/**\n * The action to perform when the key is pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[keyName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "((instance: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ") => void) | false | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "keyName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface", "docComment": "/**\n * A handle to a line in a CodeMirror 5 document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5LineHandle " } ], "fileUrlPath": "src/codemirror/internals/Cm5LineHandle.d.ts", "releaseTag": "Public", "name": "Cm5LineHandle", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5LineHandle#off:member(1)", "docComment": "/**\n * Removes an event listener for the specified event.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(eventName: " }, { "kind": "Content", "text": "'change'" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(instance: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ", changeObj: " }, { "kind": "Reference", "text": "Cm5EditorChange", "canonicalReference": "obsidian-typings!Cm5EditorChange:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5LineHandle#off:member(2)", "docComment": "/**\n * Removes an event listener for the specified event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(eventName: " }, { "kind": "Content", "text": "'delete'" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5LineHandle#on:member(1)", "docComment": "/**\n * Registers an event listener for the specified event.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(eventName: " }, { "kind": "Content", "text": "'change'" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(instance: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ", changeObj: " }, { "kind": "Reference", "text": "Cm5EditorChange", "canonicalReference": "obsidian-typings!Cm5EditorChange:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5LineHandle#on:member(2)", "docComment": "/**\n * Registers an event listener for the specified event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(eventName: " }, { "kind": "Content", "text": "'delete'" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineHandle#text:member", "docComment": "/**\n * The text content of the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5LineInfo:interface", "docComment": "/**\n * Information about a line in a CodeMirror 5 editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5LineInfo " } ], "fileUrlPath": "src/codemirror/internals/Cm5LineInfo.d.ts", "releaseTag": "Public", "name": "Cm5LineInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineInfo#bgClass:member", "docComment": "/**\n * The background CSS class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bgClass: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bgClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineInfo#gutterMarkers:member", "docComment": "/**\n * Object mapping gutter IDs to marker elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gutterMarkers: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "gutterMarkers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineInfo#handle:member", "docComment": "/**\n * The line handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handle: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "handle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineInfo#line:member", "docComment": "/**\n * The line number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "line", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineInfo#text:member", "docComment": "/**\n * The text content of the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineInfo#textClass:member", "docComment": "/**\n * The text CSS class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textClass: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "textClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineInfo#widgets:member", "docComment": "/**\n * Array of line widgets attached to this line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "widgets: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "widgets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineInfo#wrapClass:member", "docComment": "/**\n * The wrapper CSS class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wrapClass: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wrapClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5LineWidget:interface", "docComment": "/**\n * A line widget in a CodeMirror 5 editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5LineWidget " } ], "fileUrlPath": "src/codemirror/internals/Cm5LineWidget.d.ts", "releaseTag": "Public", "name": "Cm5LineWidget", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5LineWidget#changed:member(1)", "docComment": "/**\n * Call this if you made some change to the widget's DOM node that might affect its height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changed(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "changed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5LineWidget#clear:member(1)", "docComment": "/**\n * Removes the widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5LineWidget#off:member(1)", "docComment": "/**\n * Removes an event listener.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(eventName: " }, { "kind": "Content", "text": "'redraw'" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5LineWidget#on:member(1)", "docComment": "/**\n * Registers an event listener.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(eventName: " }, { "kind": "Content", "text": "'redraw'" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions:interface", "docComment": "/**\n * Options for creating a line widget in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5LineWidgetOptions " } ], "fileUrlPath": "src/codemirror/internals/Cm5LineWidgetOptions.d.ts", "releaseTag": "Public", "name": "Cm5LineWidgetOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions#above:member", "docComment": "/**\n * Causes the widget to be placed above instead of below the text of the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "above?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "above", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions#className:member", "docComment": "/**\n * Add an extra CSS class name to the wrapper element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "className?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "className", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions#coverGutter:member", "docComment": "/**\n * Whether the widget should cover the gutter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "coverGutter?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "coverGutter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions#handleMouseEvents:member", "docComment": "/**\n * Whether the editor will capture mouse and drag events occurring in this widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleMouseEvents?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "handleMouseEvents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions#insertAt:member", "docComment": "/**\n * Position at which to insert the widget (zero for top, N for after Nth widget).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertAt?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "insertAt", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions#noHScroll:member", "docComment": "/**\n * Whether the widget should stay fixed in the face of horizontal scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "noHScroll?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "noHScroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions#showIfHidden:member", "docComment": "/**\n * When `true`, will cause the widget to be rendered even if the line is hidden.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showIfHidden?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showIfHidden", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5LinkedDocOptions:interface", "docComment": "/**\n * Options for creating a linked document in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5LinkedDocOptions " } ], "fileUrlPath": "src/codemirror/internals/Cm5LinkedDocOptions.d.ts", "releaseTag": "Public", "name": "Cm5LinkedDocOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LinkedDocOptions#from:member", "docComment": "/**\n * The start line of the subview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LinkedDocOptions#mode:member", "docComment": "/**\n * A different mode for the linked document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode?: " }, { "kind": "Reference", "text": "Cm5ModeSpec", "canonicalReference": "obsidian-typings!Cm5ModeSpec:type" }, { "kind": "Content", "text": "<unknown> | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LinkedDocOptions#sharedHist:member", "docComment": "/**\n * Whether to share undo history with the original.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sharedHist?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sharedHist", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5LinkedDocOptions#to:member", "docComment": "/**\n * The end line of the subview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5Mode:interface", "docComment": "/**\n * A CodeMirror 5 mode definition for syntax highlighting.\n *\n * @typeParam T - The type of the mode's state object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5Mode<T> " } ], "fileUrlPath": "src/codemirror/internals/Cm5Mode.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "Cm5Mode", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Mode#blankLine:member(1)", "docComment": "/**\n * Called whenever a blank line is passed over, so that the parser state can be updated.\n *\n * @param state - The current parser state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blankLine?(state: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "blankLine" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Mode#blockCommentEnd:member", "docComment": "/**\n * String that ends a block comment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blockCommentEnd?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "blockCommentEnd", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Mode#blockCommentLead:member", "docComment": "/**\n * String to put at the start of continued lines in a block comment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blockCommentLead?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "blockCommentLead", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Mode#blockCommentStart:member", "docComment": "/**\n * String that starts a block comment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blockCommentStart?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "blockCommentStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Mode#copyState:member(1)", "docComment": "/**\n * Given a state, returns a safe copy of that state.\n *\n * @param state - The state to copy.\n *\n * @returns A copy of the state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copyState?(state: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "copyState" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Mode#electricChars:member", "docComment": "/**\n * Trigger a re-indent whenever one of the characters in the string is typed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "electricChars?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "electricChars", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Mode#electricInput:member", "docComment": "/**\n * Trigger a re-indent whenever the regex matches the part of the line before the cursor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "electricInput?: " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "electricInput", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Mode#indent:member(1)", "docComment": "/**\n * Returns the number of spaces of indentation that should be used.\n *\n * @param state - The current parser state.\n *\n * @param textAfter - The text after the current position.\n *\n * @param line - The whole text of the line.\n *\n * @returns The number of spaces to indent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indent?(state: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ", textAfter: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", line: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "textAfter", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "indent" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Mode#lineComment:member", "docComment": "/**\n * String that starts a line comment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineComment?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lineComment", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Mode#name:member", "docComment": "/**\n * The name of the mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Mode#startState:member(1)", "docComment": "/**\n * Produces a state object to be used at the start of a document.\n *\n * @returns The initial state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startState?(): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "startState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Mode#token:member(1)", "docComment": "/**\n * Reads one token from the stream, optionally updates the state, and returns a style string.\n *\n * @param stream - The string stream to read from.\n *\n * @param state - The current parser state.\n *\n * @returns A style string, or `null` for unstyled tokens.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "token(stream: " }, { "kind": "Reference", "text": "Cm5StringStream", "canonicalReference": "obsidian-typings!Cm5StringStream:interface" }, { "kind": "Content", "text": ", state: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "stream", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "token" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5ModeFactory:interface", "docComment": "/**\n * A factory function that creates a {@link Cm5Mode} given an editor configuration.\n *\n * @typeParam T - The type of the mode's state object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5ModeFactory<T> " } ], "fileUrlPath": "src/codemirror/internals/Cm5ModeFactory.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "Cm5ModeFactory", "preserveMemberOrder": false, "members": [ { "kind": "CallSignature", "canonicalReference": "obsidian-typings!Cm5ModeFactory:call(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "(config: " }, { "kind": "Reference", "text": "Cm5EditorConfiguration", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration:interface" }, { "kind": "Content", "text": ", modeOptions?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "modeOptions", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ] } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!Cm5ModeSpec:type", "docComment": "/**\n * A mode specification for CodeMirror 5 with a required name and additional options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Cm5ModeSpec<T> = " }, { "kind": "Content", "text": "{ [P in keyof T]: T[P] } & { name: string }" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/Cm5ModeSpec.d.ts", "releaseTag": "Public", "name": "Cm5ModeSpec", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5MouseSelectionConfiguration:interface", "docComment": "/**\n * Configuration for mouse selection behavior in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5MouseSelectionConfiguration " } ], "fileUrlPath": "src/codemirror/internals/Cm5MouseSelectionConfiguration.d.ts", "releaseTag": "Public", "name": "Cm5MouseSelectionConfiguration", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5MouseSelectionConfiguration#addNew:member", "docComment": "/**\n * Whether to add a new range to the existing selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addNew?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "addNew", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5MouseSelectionConfiguration#extend:member", "docComment": "/**\n * Whether to extend the existing selection range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extend?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "extend", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5MouseSelectionConfiguration#moveOnDrag:member", "docComment": "/**\n * Whether dragged content is moved (`true`) or copied (`false`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveOnDrag?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "moveOnDrag", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5MouseSelectionConfiguration#unit:member", "docComment": "/**\n * The unit by which to select.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unit?: " }, { "kind": "Content", "text": "'char' | 'line' | 'rectangle' | 'word' | " }, { "kind": "Reference", "text": "Cm5SelectionUnit", "canonicalReference": "obsidian-typings!Cm5SelectionUnit:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "unit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5OverlayOptions:interface", "docComment": "/**\n * Options for adding a mode overlay in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5OverlayOptions " } ], "fileUrlPath": "src/codemirror/internals/Cm5OverlayOptions.d.ts", "releaseTag": "Public", "name": "Cm5OverlayOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5OverlayOptions#opaque:member", "docComment": "/**\n * Whether the overlay styling overrides the base mode entirely.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "opaque?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "opaque", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5OverlayOptions#priority:member", "docComment": "/**\n * The priority of the overlay.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "priority?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "priority", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5Pass:interface", "docComment": "/**\n * A sentinel value that can be returned from key handlers to indicate the key should be handled by the next handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5Pass " } ], "fileUrlPath": "src/codemirror/internals/Cm5Pass.d.ts", "releaseTag": "Public", "name": "Cm5Pass", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Pass#toString:member(1)", "docComment": "/**\n * Returns the string \"CodeMirror.PASS\".\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toString(): " }, { "kind": "Content", "text": "'CodeMirror.PASS'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toString" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5PositionRange:interface", "docComment": "/**\n * A position range with from and to in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5PositionRange " } ], "fileUrlPath": "src/codemirror/internals/Cm5PositionRange.d.ts", "releaseTag": "Public", "name": "Cm5PositionRange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5PositionRange#from:member", "docComment": "/**\n * The start position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5PositionRange#to:member", "docComment": "/**\n * The end position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5Range:interface", "docComment": "/**\n * A selection range in a CodeMirror 5 document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5Range " } ], "fileUrlPath": "src/codemirror/internals/Cm5Range.d.ts", "releaseTag": "Public", "name": "Cm5Range", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Range#anchor:member", "docComment": "/**\n * The fixed end of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "anchor: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "anchor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Range#empty:member(1)", "docComment": "/**\n * Returns `true` if the range is empty (anchor equals head).\n *\n * @returns Whether the range is empty.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "empty(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "empty" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Range#from:member(1)", "docComment": "/**\n * Returns the earlier of anchor and head.\n *\n * @returns The start position of the range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from(): " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "from" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Range#head:member", "docComment": "/**\n * The moving end of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "head: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "head", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5Range#to:member(1)", "docComment": "/**\n * Returns the later of anchor and head.\n *\n * @returns The end position of the range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to(): " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "to" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5ScrollInfo:interface", "docComment": "/**\n * Scroll position information for a CodeMirror 5 editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5ScrollInfo " } ], "fileUrlPath": "src/codemirror/internals/Cm5ScrollInfo.d.ts", "releaseTag": "Public", "name": "Cm5ScrollInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5ScrollInfo#clientHeight:member", "docComment": "/**\n * The visible area height (minus scrollbars).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clientHeight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clientHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5ScrollInfo#clientWidth:member", "docComment": "/**\n * The visible area width (minus scrollbars).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clientWidth: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clientWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5ScrollInfo#height:member", "docComment": "/**\n * Total scrollable height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5ScrollInfo#left:member", "docComment": "/**\n * Current horizontal scroll position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5ScrollInfo#top:member", "docComment": "/**\n * Current vertical scroll position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5ScrollInfo#width:member", "docComment": "/**\n * Total scrollable width.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface", "docComment": "/**\n * Options for selection operations in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5SelectionOptions " } ], "fileUrlPath": "src/codemirror/internals/Cm5SelectionOptions.d.ts", "releaseTag": "Public", "name": "Cm5SelectionOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5SelectionOptions#bias:member", "docComment": "/**\n * Direction into which selection endpoints should be adjusted (-1 backward, 1 forward).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bias?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "bias", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5SelectionOptions#origin:member", "docComment": "/**\n * Determines whether the selection history event may be merged with the previous one.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5SelectionOptions#scroll:member", "docComment": "/**\n * Determines whether the selection head should be scrolled into view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scroll?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5SelectionRange:interface", "docComment": "/**\n * A selection range input for CodeMirror 5 selection operations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5SelectionRange " } ], "fileUrlPath": "src/codemirror/internals/Cm5SelectionRange.d.ts", "releaseTag": "Public", "name": "Cm5SelectionRange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5SelectionRange#anchor:member", "docComment": "/**\n * The fixed end of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "anchor: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "anchor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5SelectionRange#head:member", "docComment": "/**\n * The moving end of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "head: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "head", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5SelectionUnit:interface", "docComment": "/**\n * A custom selection unit function for CodeMirror 5 mouse selection.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5SelectionUnit " } ], "fileUrlPath": "src/codemirror/internals/Cm5SelectionUnit.d.ts", "releaseTag": "Public", "name": "Cm5SelectionUnit", "preserveMemberOrder": false, "members": [ { "kind": "CallSignature", "canonicalReference": "obsidian-typings!Cm5SelectionUnit:call(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "(cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ", pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5PositionRange", "canonicalReference": "obsidian-typings!Cm5PositionRange:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5StringStream:interface", "docComment": "/**\n * A CodeMirror 5 StringStream instance for tokenizing text.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5StringStream " } ], "fileUrlPath": "src/codemirror/internals/Cm5StringStream.d.ts", "releaseTag": "Public", "name": "Cm5StringStream", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#backUp:member(1)", "docComment": "/**\n * Backs up the stream n characters.\n *\n * @param n - The number of characters to back up.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backUp(n: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "backUp" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#column:member(1)", "docComment": "/**\n * Returns the column (taking into account tabs) at which the current token starts.\n *\n * @returns The column number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "column(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "column" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#current:member(1)", "docComment": "/**\n * Gets the string between the start of the current token and the current stream position.\n *\n * @returns The current token string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "current(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "current" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#eat:member(1)", "docComment": "/**\n * If the next character in the stream matches the given argument, it is consumed and returned.\n *\n * @param match - A character, regular expression, or predicate function.\n *\n * @returns The matched character, or empty string if no match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eat(match: " }, { "kind": "Content", "text": "((char: string) => boolean) | " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "match", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "eat" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#eatSpace:member(1)", "docComment": "/**\n * Shortcut for eatWhile when matching white-space.\n *\n * @returns `true` if any whitespace was consumed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eatSpace(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "eatSpace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#eatWhile:member(1)", "docComment": "/**\n * Repeatedly calls eat with the given argument, until it fails.\n *\n * @param match - A character, regular expression, or predicate function.\n *\n * @returns `true` if any characters were consumed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eatWhile(match: " }, { "kind": "Content", "text": "((char: string) => boolean) | " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "match", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "eatWhile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#eol:member(1)", "docComment": "/**\n * Returns `true` only if the stream is at the end of the line.\n *\n * @returns Whether the stream is at end of line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eol(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "eol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#indentation:member(1)", "docComment": "/**\n * Tells you how far the current line has been indented, in spaces.\n *\n * @returns The indentation in spaces.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentation(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "indentation" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5StringStream#lastColumnPos:member", "docComment": "/**\n * Position in the string where the last column measurement was taken.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastColumnPos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastColumnPos", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5StringStream#lastColumnValue:member", "docComment": "/**\n * Cached column value at {@link Cm5StringStream.lastColumnPos}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastColumnValue: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastColumnValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5StringStream#lineStart:member", "docComment": "/**\n * Start offset of the current line within the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineStart: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#lookAhead:member(1)", "docComment": "/**\n * Look ahead and return the character n characters ahead without advancing.\n *\n * @param n - The number of characters to look ahead.\n *\n * @returns The character, or `undefined` if past end of line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lookAhead(n: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "lookAhead" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#match:member(1)", "docComment": "/**\n * Matches against a string or regular expression pattern.\n *\n * @param pattern - The string pattern to match.\n *\n * @param consume - Whether to advance the stream on match.\n *\n * @param caseFold - Whether to match case-insensitively.\n *\n * @returns `true` if the pattern matched.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "match(pattern: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", consume?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", caseFold?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pattern", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "consume", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "caseFold", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "match" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#match:member(2)", "docComment": "/**\n * Matches against a regular expression pattern.\n *\n * @param pattern - The regular expression to match.\n *\n * @param consume - Whether to advance the stream on match.\n *\n * @returns The match array, or `null` if no match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "match(pattern: " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ", consume?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "pattern", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "consume", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "match" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#next:member(1)", "docComment": "/**\n * Returns the next character in the stream and advances it.\n *\n * @returns The next character, or `null` at end of line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "next(): " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "next" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#peek:member(1)", "docComment": "/**\n * Returns the next character in the stream without advancing it.\n *\n * @returns The next character, or `null` at end of line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "peek(): " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "peek" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5StringStream#pos:member", "docComment": "/**\n * Current position in the string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pos", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#skipTo:member(1)", "docComment": "/**\n * Skips to the next occurrence of the given character on the current line.\n *\n * @param ch - The character to skip to.\n *\n * @returns `true` if the character was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skipTo(ch: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ch", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "skipTo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#skipToEnd:member(1)", "docComment": "/**\n * Moves the position to the end of the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skipToEnd(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "skipToEnd" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Cm5StringStream#sol:member(1)", "docComment": "/**\n * Returns `true` only if the stream is at the start of the line.\n *\n * @returns Whether the stream is at start of line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sol(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "sol" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5StringStream#start:member", "docComment": "/**\n * Position where the current token started.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "start", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5StringStream#string:member", "docComment": "/**\n * The current line's content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "string: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "string", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5StringStream#tabSize:member", "docComment": "/**\n * Number of spaces per tab character.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabSize: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tabSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions:interface", "docComment": "/**\n * Options for creating a text marker in CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5TextMarkerOptions " } ], "fileUrlPath": "src/codemirror/internals/Cm5TextMarkerOptions.d.ts", "releaseTag": "Public", "name": "Cm5TextMarkerOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#addToHistory:member", "docComment": "/**\n * When set to `true`, adding this marker will create an event in the undo history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addToHistory?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "addToHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#atomic:member", "docComment": "/**\n * Atomic ranges act as a single unit when cursor movement is concerned.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "atomic?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "atomic", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#attributes:member", "docComment": "/**\n * When given, add the attributes to the elements created for the marked text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attributes?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "attributes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#className:member", "docComment": "/**\n * Assigns a CSS class to the marked stretch of text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "className?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "className", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#clearOnEnter:member", "docComment": "/**\n * When enabled, will cause the mark to clear itself whenever the cursor enters its range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearOnEnter?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "clearOnEnter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#clearWhenEmpty:member", "docComment": "/**\n * Determines whether the mark is automatically cleared when it becomes empty.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearWhenEmpty?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "clearWhenEmpty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#collapsed:member", "docComment": "/**\n * Collapsed ranges do not show up in the display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapsed?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "collapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#css:member", "docComment": "/**\n * A string of CSS to be applied to the covered text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "css?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "css", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#endStyle:member", "docComment": "/**\n * Equivalent to startStyle, but for the rightmost span.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "endStyle?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "endStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#handleMouseEvents:member", "docComment": "/**\n * Whether the editor will capture mouse and drag events occurring in this widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleMouseEvents?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "handleMouseEvents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#inclusiveLeft:member", "docComment": "/**\n * Determines whether text inserted on the left of the marker will end up inside or outside of it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inclusiveLeft?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inclusiveLeft", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#inclusiveRight:member", "docComment": "/**\n * Like inclusiveLeft, but for the right side.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inclusiveRight?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inclusiveRight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#readOnly:member", "docComment": "/**\n * A read-only span cannot be modified except by calling setValue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readOnly?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "readOnly", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#replacedWith:member", "docComment": "/**\n * Use a given node to display this range. Implies both collapsed and atomic.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replacedWith?: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "replacedWith", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#selectLeft:member", "docComment": "/**\n * For atomic ranges, determines whether the cursor is allowed to be placed directly to the left.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectLeft?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selectLeft", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#selectRight:member", "docComment": "/**\n * Like selectLeft, but for the right side.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectRight?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selectRight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#shared:member", "docComment": "/**\n * When set to `true`, makes the marker appear in all linked documents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shared?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "shared", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#startStyle:member", "docComment": "/**\n * Can be used to specify an extra CSS class for the leftmost span of the marker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startStyle?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "startStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions#title:member", "docComment": "/**\n * When given, will give the nodes a HTML title attribute with the given value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5Token:interface", "docComment": "/**\n * A token returned by CodeMirror 5's tokenizer.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5Token " } ], "fileUrlPath": "src/codemirror/internals/Cm5Token.d.ts", "releaseTag": "Public", "name": "Cm5Token", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Token#end:member", "docComment": "/**\n * The character at which the token ends.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "end: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "end", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Token#start:member", "docComment": "/**\n * The character (on the given line) at which the token starts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "start", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Token#state:member", "docComment": "/**\n * The mode's state at the end of this token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Token#string:member", "docComment": "/**\n * The token's string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "string: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "string", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Token#type:member", "docComment": "/**\n * The token type the mode assigned to the token, such as \"keyword\" or \"comment\".\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Cm5Viewport:interface", "docComment": "/**\n * The currently rendered viewport range in a CodeMirror 5 editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Cm5Viewport " } ], "fileUrlPath": "src/codemirror/internals/Cm5Viewport.d.ts", "releaseTag": "Public", "name": "Cm5Viewport", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Viewport#from:member", "docComment": "/**\n * The start line of the viewport (inclusive).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Cm5Viewport#to:member", "docComment": "/**\n * The end line of the viewport (exclusive).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CmRange:interface", "docComment": "/**\n * A range associates a value with a range of positions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CmRange<T extends " }, { "kind": "Reference", "text": "RangeValue", "canonicalReference": "@codemirror/state!RangeValue:class" }, { "kind": "Content", "text": "> " } ], "fileUrlPath": "src/@codemirror__state/internals/CmRange.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "CmRange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CmRange#from:member", "docComment": "/**\n * The start of the range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CmRange#to:member", "docComment": "/**\n * The end of the range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CmRange#value:member", "docComment": "/**\n * The value associated with this range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!CmText:class", "docComment": "/**\n * The document data type used in CodeMirror.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class CmText " } ], "fileUrlPath": "src/@codemirror__state/internals/CmText.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "CmText", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!CmText.empty:member", "docComment": "/**\n * An empty document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static empty: " }, { "kind": "Reference", "text": "CmText", "canonicalReference": "obsidian-typings!CmText:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "empty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!CmText#length:member", "docComment": "/**\n * The length of the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!CmText#line:member(1)", "docComment": "/**\n * Get the line at a given 1-based line number.\n *\n * @param n - The 1-based line number.\n *\n * @returns The line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "line(n: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Line", "canonicalReference": "@codemirror/state!Line:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "line" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CmText#lineAt:member(1)", "docComment": "/**\n * Get the line at the given position.\n *\n * @param pos - The position.\n *\n * @returns The line containing the position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineAt(pos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Line", "canonicalReference": "@codemirror/state!Line:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "lineAt" }, { "kind": "Property", "canonicalReference": "obsidian-typings!CmText#lines:member", "docComment": "/**\n * The number of lines in the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly lines: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "lines", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!CmText.of:member(1)", "docComment": "/**\n * Create a text from an array of lines.\n *\n * @param text - The lines to create the text from.\n *\n * @returns The created text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static of(text: " }, { "kind": "Content", "text": "readonly string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CmText", "canonicalReference": "obsidian-typings!CmText:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "of" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CmText#sliceString:member(1)", "docComment": "/**\n * Return the document as a string, using newline characters to separate lines.\n *\n * @param from - The start position.\n *\n * @param to - The end position.\n *\n * @param lineSep - The line separator to use.\n *\n * @returns The string content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sliceString(from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", to?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", lineSep?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "lineSep", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "sliceString" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CmText#toString:member(1)", "docComment": "/**\n * Return the document as a string.\n *\n * @returns The string content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toString(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "toString" } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!CodeBlockPostProcessorHandler:type", "docComment": "/**\n * Handler function for post processing a code block.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type CodeBlockPostProcessorHandler = " }, { "kind": "Content", "text": "(\n source: string,\n el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ",\n ctx: " }, { "kind": "Reference", "text": "MarkdownPostProcessorContext", "canonicalReference": "obsidian!MarkdownPostProcessorContext:interface" }, { "kind": "Content", "text": "\n) => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void> | void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/CodeBlockPostProcessorHandler.d.ts", "releaseTag": "Public", "name": "CodeBlockPostProcessorHandler", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx:interface", "docComment": "/**\n * Extended CodeMirror adapter providing CM5-compatible API over CM6.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CodeMirrorAdapterEx " } ], "fileUrlPath": "src/@codemirror__view/internals/CodeMirrorAdapterEx.d.ts", "releaseTag": "Public", "name": "CodeMirrorAdapterEx", "preserveMemberOrder": false, "members": [ { "kind": "ConstructSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx:new(1)", "docComment": "/**\n * Construct a new CodeMirror editor instance from a Vim editor.\n *\n * @param cm6 - The Vim editor instance to wrap.\n *\n * @returns The created CodeMirror editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "new (cm6: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CodeMirrorEditor", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm6", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#addClass:member(1)", "docComment": "/**\n * Add a CSS class to an HTML element.\n *\n * @param element - The HTML element to add the class to.\n *\n * @param className - The CSS class name to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addClass(element: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", className: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "className", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addClass" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#commands:member", "docComment": "/**\n * Built-in editor commands (undo, redo, indent, etc.).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commands: " }, { "kind": "Reference", "text": "CodeMirrorAdapterExCommands", "canonicalReference": "obsidian-typings!CodeMirrorAdapterExCommands:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "commands", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#defineOption:member(1)", "docComment": "/**\n * Define a new editor option with a default value and change handler.\n *\n * @param option - The name of the option.\n *\n * @param defaultValue - The default value for the option.\n *\n * @param handler - The handler invoked when the option changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineOption(option: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", defaultValue: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "option", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "defaultValue", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "defineOption" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#e_preventDefault:member(1)", "docComment": "/**\n * Call preventDefault on the given event.\n *\n * @param event - The event to prevent default on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "e_preventDefault(event: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "e_preventDefault" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#e_stop:member(1)", "docComment": "/**\n * Stop propagation and prevent default on the given event.\n *\n * @param event - The event to stop.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "e_stop(event: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "e_stop" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#findEnclosingTag:member(1)", "docComment": "/**\n * Find the enclosing HTML/XML tag at the given position.\n *\n * @param doc - The CodeMirror adapter instance.\n *\n * @param pos - The editor position to search from.\n *\n * @returns The enclosing tag, or `undefined` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findEnclosingTag(doc: " }, { "kind": "Reference", "text": "CodeMirrorAdapterEx", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx:interface" }, { "kind": "Content", "text": ", pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EnclosingTag", "canonicalReference": "obsidian-typings!EnclosingTag:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "doc", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "findEnclosingTag" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#findMatchingTag:member(1)", "docComment": "/**\n * Find the matching HTML/XML tag at the given position.\n *\n * @param doc - The CodeMirror adapter instance.\n *\n * @param pos - The editor position to search from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findMatchingTag(doc: " }, { "kind": "Reference", "text": "CodeMirrorAdapterEx", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx:interface" }, { "kind": "Content", "text": ", pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "doc", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "findMatchingTag" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#isMac:member", "docComment": "/**\n * Whether the current platform is macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMac: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMac", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#isWordChar:member(1)", "docComment": "/**\n * Check whether the given character is a word character.\n *\n * @param char - The character to check.\n *\n * @returns Whether the character is a word character.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isWordChar(char: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "char", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isWordChar" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#keyMap:member", "docComment": "/**\n * Map of key binding names to their handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyMap: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyMap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#keyName:member(1)", "docComment": "/**\n * Get the key name string from a keyboard event.\n *\n * @param event - The keyboard event.\n *\n * @returns The key name string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyName(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "keyName" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#keys:member", "docComment": "/**\n * Map of key names to their handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keys: " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#lookupKey:member(1)", "docComment": "/**\n * Look up a key binding and invoke the callback with the associated action.\n *\n * @param key - The key binding to look up.\n *\n * @param context - The context for the key lookup.\n *\n * @param callback - The callback invoked with the associated action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lookupKey(\n key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n context: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ",\n callback: " }, { "kind": "Content", "text": "(action: (codeMirrorAdapter: " }, { "kind": "Reference", "text": "CodeMirrorAdapterEx", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx:interface" }, { "kind": "Content", "text": ") => boolean) => void" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": false } ], "name": "lookupKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#off:member(1)", "docComment": "/**\n * Remove an event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The event listener to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Reference", "text": "EventListenerOrEventListenerObject", "canonicalReference": "!EventListenerOrEventListenerObject:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#on:member(1)", "docComment": "/**\n * Add an event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The event listener to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Reference", "text": "EventListenerOrEventListenerObject", "canonicalReference": "!EventListenerOrEventListenerObject:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#Pos:member", "docComment": "/**\n * Constructor for creating editor position objects.\n *\n * @param line - The line number.\n *\n * @param ch - The character offset.\n *\n * @returns The created editor position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Pos: " }, { "kind": "Content", "text": "new (line: number, ch: number) => " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Pos", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#rmClass:member(1)", "docComment": "/**\n * Remove a CSS class from an HTML element.\n *\n * @param element - The HTML element to remove the class from.\n *\n * @param className - The CSS class name to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rmClass(element: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", className: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "className", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "rmClass" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#signal:member(1)", "docComment": "/**\n * Emit a signal/event on the given target.\n *\n * @param target - The target to emit the signal on.\n *\n * @param type - The signal/event type.\n *\n * @param values - Additional values to pass to the signal handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "signal(target: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...values: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "signal" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#StringStream:member", "docComment": "/**\n * StringStream class for tokenizing input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "StringStream: " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<[text: string], " }, { "kind": "Reference", "text": "Cm5StringStream", "canonicalReference": "obsidian-typings!Cm5StringStream:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "StringStream", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#Vim:member", "docComment": "/**\n * The Vim API instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Vim: " }, { "kind": "Reference", "text": "VimApi", "canonicalReference": "obsidian-typings!VimApi:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Vim", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterEx#vimKey:member(1)", "docComment": "/**\n * Convert a keyboard event to its Vim key representation.\n *\n * @param event - The keyboard event.\n *\n * @returns The Vim key representation string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vimKey(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "vimKey" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CodeMirrorAdapterExCommands:interface", "docComment": "/**\n * Built-in editor commands available through the CodeMirror adapter.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CodeMirrorAdapterExCommands " } ], "fileUrlPath": "src/@codemirror__view/internals/CodeMirrorAdapterExCommands.d.ts", "releaseTag": "Public", "name": "CodeMirrorAdapterExCommands", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterExCommands#cursorCharLeft:member(1)", "docComment": "/**\n * Move the cursor one character to the left.\n *\n * @param editor - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursorCharLeft(editor: " }, { "kind": "Reference", "text": "CodeMirrorEditor", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "cursorCharLeft" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterExCommands#indentAuto:member(1)", "docComment": "/**\n * Auto-indent the current line or selection.\n *\n * @param editor - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentAuto(editor: " }, { "kind": "Reference", "text": "CodeMirrorEditor", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "indentAuto" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterExCommands#newlineAndIndent:member(1)", "docComment": "/**\n * Insert a new line and auto-indent.\n *\n * @param editor - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newlineAndIndent(editor: " }, { "kind": "Reference", "text": "CodeMirrorEditor", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "newlineAndIndent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterExCommands#newlineAndIndentBefore:member(1)", "docComment": "/**\n * Insert a new line before the current line and auto-indent.\n *\n * @param editor - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newlineAndIndentBefore(editor: " }, { "kind": "Reference", "text": "CodeMirrorEditor", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "newlineAndIndentBefore" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterExCommands#redo:member(1)", "docComment": "/**\n * Redo the last undone change.\n *\n * @param editor - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redo(editor: " }, { "kind": "Reference", "text": "CodeMirrorEditor", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "redo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorAdapterExCommands#undo:member(1)", "docComment": "/**\n * Undo the last change.\n *\n * @param editor - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undo(editor: " }, { "kind": "Reference", "text": "CodeMirrorEditor", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "undo" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CodeMirrorEditor:interface", "docComment": "/**\n * CM5-compatible editor interface wrapping a CodeMirror 6 editor view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CodeMirrorEditor " } ], "fileUrlPath": "src/@codemirror__view/internals/CodeMirrorEditor.d.ts", "releaseTag": "Public", "name": "CodeMirrorEditor", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#$lineHandleChanges:member", "docComment": "/**\n * Pending line handle changes to be processed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "$lineHandleChanges: " }, { "kind": "Reference", "text": "LineHandleChange", "canonicalReference": "obsidian-typings!LineHandleChange:interface" }, { "kind": "Content", "text": "[] | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "$lineHandleChanges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#addOverlay:member(1)", "docComment": "/**\n * Add a search overlay to highlight matches in the editor.\n *\n * @param options - The overlay options containing the search pattern.\n *\n * @returns The search query, or `undefined` if the overlay could not be added.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addOverlay(options: " }, { "kind": "Reference", "text": "AddOverlayOptions", "canonicalReference": "obsidian-typings!AddOverlayOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "SearchQuery", "canonicalReference": "obsidian-typings!SearchQuery:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addOverlay" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#blur:member(1)", "docComment": "/**\n * Remove focus from the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blur(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "blur" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#charCoords:member(1)", "docComment": "/**\n * Get the pixel coordinates of a character position.\n *\n * @param pos - The editor position to get coordinates for.\n *\n * @param mode - The coordinate system to use.\n *\n * @returns The pixel coordinates of the position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "charCoords(pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", mode: " }, { "kind": "Content", "text": "'div' | 'local' | 'page' | 'window'" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Coords", "canonicalReference": "obsidian-typings!Coords:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "charCoords" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#clipPos:member(1)", "docComment": "/**\n * Clip a position to be within the document bounds.\n *\n * @param pos - The editor position to clip.\n *\n * @returns The clipped position within document bounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clipPos(pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "clipPos" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#coordsChar:member(1)", "docComment": "/**\n * Get the editor position corresponding to pixel coordinates.\n *\n * @param coords - The pixel coordinates to convert.\n *\n * @param mode - The coordinate system of the input coordinates.\n *\n * @returns The editor position at the given coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "coordsChar(coords: " }, { "kind": "Reference", "text": "Coords", "canonicalReference": "obsidian-typings!Coords:interface" }, { "kind": "Content", "text": ", mode: " }, { "kind": "Content", "text": "'div' | 'local' | 'page' | 'window'" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "coords", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "coordsChar" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#defaultTextHeight:member(1)", "docComment": "/**\n * Get the default height of a line of text in pixels.\n *\n * @returns The default text height in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultTextHeight(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "defaultTextHeight" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#destroy:member(1)", "docComment": "/**\n * Destroy and clean up resources.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#execCommand:member(1)", "docComment": "/**\n * Execute a named editor command.\n *\n * @param command - The name of the command to execute.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "execCommand(command: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "execCommand" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#findMatchingBracket:member(1)", "docComment": "/**\n * Find the matching bracket for the bracket at the given position.\n *\n * @param pos - The position of the bracket to match.\n *\n * @returns The matching bracket result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findMatchingBracket(pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "MatchingBracket", "canonicalReference": "obsidian-typings!MatchingBracket:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "findMatchingBracket" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#findPosV:member(1)", "docComment": "/**\n * Find a position vertically relative to the given start position.\n *\n * @param start - The starting editor position.\n *\n * @param amount - The number of units to move.\n *\n * @param unit - The unit of movement.\n *\n * @param goalColumn - The desired column to maintain.\n *\n * @returns The resulting editor position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findPosV(start: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", amount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", unit: " }, { "kind": "Content", "text": "'line' | 'page'" }, { "kind": "Content", "text": ", goalColumn: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "start", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "unit", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "goalColumn", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "findPosV" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#firstLine:member(1)", "docComment": "/**\n * Get the line number of the first line in the document.\n *\n * @returns The first line number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "firstLine(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "firstLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#focus:member(1)", "docComment": "/**\n * Focus the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#foldCode:member(1)", "docComment": "/**\n * Fold the code block at the given line.\n *\n * @param line - The line number to fold at.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "foldCode(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "foldCode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#forEachSelection:member(1)", "docComment": "/**\n * Execute a function for each selection in a multi-selection.\n *\n * @param fn - The function to execute for each selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forEachSelection(fn: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "forEachSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getCursor:member(1)", "docComment": "/**\n * Get the cursor position, optionally specifying which end of the selection.\n *\n * @param type - Which end of the selection to return.\n *\n * @returns The cursor position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCursor(type?: " }, { "kind": "Content", "text": "'anchor' | 'end' | 'head' | 'start'" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getCursor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getInputField:member(1)", "docComment": "/**\n * Get the editor's input field element.\n *\n * @returns The input field HTML element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getInputField(): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getInputField" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getLastEditEnd:member(1)", "docComment": "/**\n * Get the position of the last edit.\n *\n * @returns The position of the last edit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLastEditEnd(): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLastEditEnd" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getLine:member(1)", "docComment": "/**\n * Get the text content of the given line number.\n *\n * @param line - The line number to get text for.\n *\n * @returns The text content of the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLine(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getLineHandle:member(1)", "docComment": "/**\n * Get a handle for the given line number.\n *\n * @param line - The line number to get a handle for.\n *\n * @returns The line handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLineHandle(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "LineHandle", "canonicalReference": "obsidian-typings!LineHandle:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getLineHandle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getLineNumber:member(1)", "docComment": "/**\n * Get the line number from a line handle, or `null` if the handle is invalid.\n *\n * @param handle - The line handle to get the number for.\n *\n * @returns The line number, or `null` if the handle is invalid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLineNumber(handle: " }, { "kind": "Reference", "text": "LineHandle", "canonicalReference": "obsidian-typings!LineHandle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "handle", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getLineNumber" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getMainSelection:member(1)", "docComment": "/**\n * Get the primary selection as anchor and head positions.\n *\n * @returns The primary editor selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMainSelection(): " }, { "kind": "Reference", "text": "EditorSelection", "canonicalReference": "obsidian!EditorSelection:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMainSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getMode:member(1)", "docComment": "/**\n * Get the current editor language mode.\n *\n * @returns The editor language mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMode(): " }, { "kind": "Reference", "text": "CodeMirrorEditorMode", "canonicalReference": "obsidian-typings!CodeMirrorEditorMode:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getOption:member(1)", "docComment": "/**\n * Get the value of an editor option.\n *\n * @param option - The name of the option to get.\n *\n * @returns The option value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOption(option: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "option", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getOption" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getRange:member(1)", "docComment": "/**\n * Get the text between two positions.\n *\n * @param from - The start position.\n *\n * @param to - The end position.\n *\n * @returns The text between the two positions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRange(from: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", to: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getRange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getScrollInfo:member(1)", "docComment": "/**\n * Get information about the editor's scroll position and dimensions.\n *\n * @returns The scroll information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getScrollInfo(): " }, { "kind": "Reference", "text": "ScrollInfo", "canonicalReference": "obsidian-typings!ScrollInfo:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getScrollInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getSearchCursor:member(1)", "docComment": "/**\n * Get a search cursor for the given regular expression starting at the given position.\n *\n * @param query - The regular expression to search for.\n *\n * @param pos - The position to start searching from.\n *\n * @returns The search cursor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSearchCursor(query: " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ", pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CodeMirrorEditorSearchCursor", "canonicalReference": "obsidian-typings!CodeMirrorEditorSearchCursor:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getSearchCursor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getSelection:member(1)", "docComment": "/**\n * Get the currently selected text.\n *\n * @returns The selected text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSelection(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getSelections:member(1)", "docComment": "/**\n * Get all selections as an array of strings.\n *\n * @returns An array of selected text strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSelections(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getTokenTypeAt:member(1)", "docComment": "/**\n * Get the token type at the given position.\n *\n * @param pos - The position to get the token type for.\n *\n * @returns The token type string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTokenTypeAt(pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getTokenTypeAt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getValue:member(1)", "docComment": "/**\n * Get the full text content of the document.\n *\n * @returns The full document text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getValue(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#getWrapperElement:member(1)", "docComment": "/**\n * Get the outermost wrapper element of the editor.\n *\n * @returns The wrapper HTML element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getWrapperElement(): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWrapperElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#hardWrap:member(1)", "docComment": "/**\n * Hard-wrap text according to the given options.\n *\n * @param options - The hard wrap options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hardWrap(options: " }, { "kind": "Reference", "text": "HardWrapOptions", "canonicalReference": "obsidian-typings!HardWrapOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "hardWrap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#indentLess:member(1)", "docComment": "/**\n * Decrease the indentation of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentLess(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "indentLess" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#indentLine:member(1)", "docComment": "/**\n * Indent the given line, optionally adding more indentation.\n *\n * @param line - The line number to indent.\n *\n * @param more - Whether to add more indentation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentLine(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", more?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "more", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "indentLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#indentMore:member(1)", "docComment": "/**\n * Increase the indentation of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indentMore(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "indentMore" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#indexFromPos:member(1)", "docComment": "/**\n * Convert an editor position to a character index within the document.\n *\n * @param pos - The editor position to convert.\n *\n * @returns The character index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indexFromPos(pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "indexFromPos" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#isInMultiSelectMode:member(1)", "docComment": "/**\n * Check whether the editor is in multi-selection mode.\n *\n * @returns Whether the editor is in multi-selection mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isInMultiSelectMode(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isInMultiSelectMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#lastLine:member(1)", "docComment": "/**\n * Get the line number of the last line in the document.\n *\n * @returns The last line number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastLine(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "lastLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#lineCount:member(1)", "docComment": "/**\n * Get the total number of lines in the document.\n *\n * @returns The total number of lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineCount(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "lineCount" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#listSelections:member(1)", "docComment": "/**\n * Get all current selections as an array of anchor/head pairs.\n *\n * @returns An array of selections with anchor and head positions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "listSelections(): " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CodeMirrorEditorSelectionRange", "canonicalReference": "obsidian-typings!CodeMirrorEditorSelectionRange:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "listSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#moveByChar:member(1)", "docComment": "/**\n * Move a position by character in the given direction.\n *\n * @param pos - The starting position.\n *\n * @param dir - The direction to move.\n *\n * @param unit - The number of characters to move.\n *\n * @returns The resulting editor position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveByChar(pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", dir: " }, { "kind": "Content", "text": "'left' | 'right'" }, { "kind": "Content", "text": ", unit: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "dir", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "unit", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "moveByChar" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#moveH:member(1)", "docComment": "/**\n * Move the cursor horizontally by the given number of units.\n *\n * @param dir - The direction and amount to move.\n *\n * @param unit - The unit of movement.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveH(dir: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", unit: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "dir", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "unit", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "moveH" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#off:member(1)", "docComment": "/**\n * Remove an event listener from the editor.\n *\n * @param event - The event name.\n *\n * @param listener - The event listener to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Reference", "text": "EventListenerOrEventListenerObject", "canonicalReference": "!EventListenerOrEventListenerObject:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#on:member(1)", "docComment": "/**\n * Add an event listener to the editor.\n *\n * @param event - The event name.\n *\n * @param listener - The event listener to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Reference", "text": "EventListenerOrEventListenerObject", "canonicalReference": "!EventListenerOrEventListenerObject:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#onBeforeEndOperation:member(1)", "docComment": "/**\n * Handle pre-operation-end cleanup.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onBeforeEndOperation(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onBeforeEndOperation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#onChange:member(1)", "docComment": "/**\n * Handle a line handle change event.\n *\n * @param lineHandleChange - The line handle change to process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onChange(lineHandleChange: " }, { "kind": "Reference", "text": "LineHandleChange", "canonicalReference": "obsidian-typings!LineHandleChange:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lineHandleChange", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#onSelectionChange:member(1)", "docComment": "/**\n * Handle a selection change event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSelectionChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onSelectionChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#openDialog:member(1)", "docComment": "/**\n * Open an interactive dialog in the editor.\n *\n * @param template - The HTML template for the dialog.\n *\n * @param keyValidator - The function to validate key input.\n *\n * @param options - The dialog options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openDialog(\n template: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n keyValidator: " }, { "kind": "Content", "text": "(keyValue: string) => boolean" }, { "kind": "Content", "text": ",\n options?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "OpenDialogOptions", "canonicalReference": "obsidian-typings!OpenDialogOptions:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "template", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "keyValidator", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": true } ], "name": "openDialog" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#openNotification:member(1)", "docComment": "/**\n * Open a notification message in the editor. Returns a function to dismiss it.\n *\n * @param message - The notification message to display.\n *\n * @param options - The notification options.\n *\n * @returns A function to dismiss the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openNotification(message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "OpenNotificationOptions", "canonicalReference": "obsidian-typings!OpenNotificationOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "openNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#operation:member(1)", "docComment": "/**\n * Execute a function as a single operation, batching view updates.\n *\n * @param fn - The function to execute.\n *\n * @typeParam T - The return type of the function.\n *\n * @returns The return value of the function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "operation<T>(fn: " }, { "kind": "Content", "text": "() => T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "operation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#overWriteSelection:member(1)", "docComment": "/**\n * Overwrite the current selection with the given text.\n *\n * @param text - The text to overwrite the selection with.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overWriteSelection(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "overWriteSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#posFromIndex:member(1)", "docComment": "/**\n * Convert a character index to an editor position.\n *\n * @param index - The character index to convert.\n *\n * @returns The editor position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "posFromIndex(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "posFromIndex" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#refresh:member(1)", "docComment": "/**\n * Refresh the editor display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "refresh(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "refresh" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#releaseLineHandles:member(1)", "docComment": "/**\n * Release all tracked line handles.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "releaseLineHandles(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "releaseLineHandles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#removeOverlay:member(1)", "docComment": "/**\n * Remove a search overlay from the editor.\n *\n * @param overlay - The search query overlay to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeOverlay(overlay?: " }, { "kind": "Reference", "text": "SearchQuery", "canonicalReference": "obsidian-typings!SearchQuery:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "overlay", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "removeOverlay" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#replaceRange:member(1)", "docComment": "/**\n * Replace the text in the given range.\n *\n * @param text - The replacement text.\n *\n * @param from - The start position of the range.\n *\n * @param to - The end position of the range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceRange(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", from: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", to?: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "replaceRange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#replaceSelection:member(1)", "docComment": "/**\n * Replace the current selection with the given text.\n *\n * @param text - The replacement text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceSelection(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "replaceSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#replaceSelections:member(1)", "docComment": "/**\n * Replace all selections with the corresponding texts.\n *\n * @param texts - The replacement texts for each selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceSelections(texts: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "texts", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "replaceSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#scanForBracket:member(1)", "docComment": "/**\n * Scan for a bracket from the given position in the specified direction.\n *\n * @param from - The position to start scanning from.\n *\n * @param direction - The direction to scan (positive for forward, negative for backward).\n *\n * @param style - The style filter for brackets.\n *\n * @returns The found bracket, or `null` if none was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scanForBracket(from: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", direction: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", style?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Bracket", "canonicalReference": "obsidian-typings!Bracket:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "style", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "scanForBracket" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#scrollInfo:member(1)", "docComment": "/**\n * Get information about the editor's scroll position and dimensions.\n *\n * @returns The scroll information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollInfo(): " }, { "kind": "Reference", "text": "ScrollInfo", "canonicalReference": "obsidian-typings!ScrollInfo:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "scrollInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#scrollIntoView:member(1)", "docComment": "/**\n * Scroll the given position into view with an optional margin.\n *\n * @param pos - The position to scroll into view.\n *\n * @param margin - The margin in pixels around the position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollIntoView(pos?: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", margin?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "margin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "scrollIntoView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#scrollTo:member(1)", "docComment": "/**\n * Scroll the editor to the given coordinates.\n *\n * @param x - The horizontal scroll position.\n *\n * @param y - The vertical scroll position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollTo(x?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "scrollTo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#setBookmark:member(1)", "docComment": "/**\n * Set a bookmark at the given position.\n *\n * @param pos - The position to set the bookmark at.\n *\n * @param options - The bookmark options.\n *\n * @returns The created bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBookmark(pos: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "SetBookmarkOptions", "canonicalReference": "obsidian-typings!SetBookmarkOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Bookmark", "canonicalReference": "obsidian-typings!Bookmark:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "setBookmark" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#setCursor:member(1)", "docComment": "/**\n * Set the cursor position to the given line and character.\n *\n * @param line - The line number.\n *\n * @param ch - The character offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCursor(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", ch: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ch", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setCursor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#setOption:member(1)", "docComment": "/**\n * Set the value of an editor option.\n *\n * @param option - The name of the option to set.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOption(option: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "option", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setOption" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#setSelection:member(1)", "docComment": "/**\n * Set the selection to the given anchor and head positions.\n *\n * @param anchor - The anchor position of the selection.\n *\n * @param head - The head position of the selection.\n *\n * @param options - The selection options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSelection(anchor: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", head: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "SetSelectionOptions", "canonicalReference": "obsidian-typings!SetSelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "anchor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "head", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "setSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#setSelections:member(1)", "docComment": "/**\n * Set multiple selections, optionally specifying the primary selection index.\n *\n * @param selections - The selections to set.\n *\n * @param primaryIndex - The index of the primary selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSelections(selections: " }, { "kind": "Reference", "text": "EditorSelection", "canonicalReference": "obsidian!EditorSelection:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", primaryIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "selections", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "primaryIndex", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ], "name": "setSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#setSize:member(1)", "docComment": "/**\n * Set the size of the editor in pixels.\n *\n * @param width - The width in pixels.\n *\n * @param height - The height in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSize(width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setSize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#setValue:member(1)", "docComment": "/**\n * Set the full text content of the document.\n *\n * @param content - The text content to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#signal:member(1)", "docComment": "/**\n * Emit a signal/event on the editor.\n *\n * @param event - The event name to emit.\n *\n * @param args - Additional arguments to pass to the event handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "signal(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "signal" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#somethingSelected:member(1)", "docComment": "/**\n * Check whether there is an active selection.\n *\n * @returns Whether there is an active selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "somethingSelected(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "somethingSelected" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#toggleOverwrite:member(1)", "docComment": "/**\n * Toggle overwrite mode on or off.\n *\n * @param overwrite - Whether to enable overwrite mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleOverwrite(overwrite: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "overwrite", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toggleOverwrite" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditor#virtualSelectionMode:member(1)", "docComment": "/**\n * Check whether the editor is in virtual selection mode.\n *\n * @returns Whether the editor is in virtual selection mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "virtualSelectionMode(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "virtualSelectionMode" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CodeMirrorEditorMode:interface", "docComment": "/**\n * Describes the active editor language mode.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CodeMirrorEditorMode " } ], "fileUrlPath": "src/@codemirror__view/internals/CodeMirrorEditorMode.d.ts", "releaseTag": "Public", "name": "CodeMirrorEditorMode", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorMode#name:member", "docComment": "/**\n * Name of the active language mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CodeMirrorEditorSearchCursor:interface", "docComment": "/**\n * A cursor for iterating over search matches in the editor document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CodeMirrorEditorSearchCursor " } ], "fileUrlPath": "src/@codemirror__view/internals/CodeMirrorEditorSearchCursor.d.ts", "releaseTag": "Public", "name": "CodeMirrorEditorSearchCursor", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorSearchCursor#find:member(1)", "docComment": "/**\n * Find the next or previous match. Returns true if a match was found.\n *\n * @param reverse - Whether to search in reverse direction.\n *\n * @returns Whether a match was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "find(reverse?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reverse", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "find" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorSearchCursor#findNext:member(1)", "docComment": "/**\n * Find the next match. Returns true if a match was found.\n *\n * @returns Whether a match was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findNext(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findNext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorSearchCursor#findPrevious:member(1)", "docComment": "/**\n * Find the previous match. Returns true if a match was found.\n *\n * @returns Whether a match was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findPrevious(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findPrevious" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorSearchCursor#from:member(1)", "docComment": "/**\n * Get the start position of the current match, or void if no match.\n *\n * @returns The start position of the current match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from(): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": " | void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "from" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorSearchCursor#replace:member(1)", "docComment": "/**\n * Replace the current match with the given text.\n *\n * @param text - The replacement text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replace(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "replace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorSearchCursor#to:member(1)", "docComment": "/**\n * Get the end position of the current match, or void if no match.\n *\n * @returns The end position of the current match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to(): " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": " | void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "to" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CodeMirrorEditorSelectionRange:interface", "docComment": "/**\n * A selection range with anchor and head positions for CodeMirror editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CodeMirrorEditorSelectionRange " } ], "fileUrlPath": "src/@codemirror__view/internals/CodeMirrorEditorSelectionRange.d.ts", "releaseTag": "Public", "name": "CodeMirrorEditorSelectionRange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorSelectionRange#anchor:member", "docComment": "/**\n * The anchor position of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "anchor: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "anchor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorEditorSelectionRange#head:member", "docComment": "/**\n * The head position of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "head: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "head", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CodeMirrorModule:interface", "docComment": "/**\n * The CodeMirror 5 library module type, representing the `window.CodeMirror` object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CodeMirrorModule " } ], "fileUrlPath": "src/codemirror/internals/CodeMirrorModule.d.ts", "releaseTag": "Public", "name": "CodeMirrorModule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#addClass:member", "docComment": "/**\n * Adds a CSS class to a node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addClass: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "addClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#changeEnd:member(1)", "docComment": "/**\n * Computes the end position of a change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeEnd(change: " }, { "kind": "Reference", "text": "Cm5EditorChange", "canonicalReference": "obsidian-typings!Cm5EditorChange:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "change", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "changeEnd" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#cmpPos:member(1)", "docComment": "/**\n * Compares two positions.\n *\n * @param a - The first position.\n *\n * @param b - The second position.\n *\n * @returns A negative number if `a` is before `b`, positive if after, zero if equal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cmpPos(a: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", b: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "a", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "cmpPos" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#commands:member", "docComment": "/**\n * A map of built-in CodeMirror 5 commands.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commands: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, (cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ") => void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "commands", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#contains:member", "docComment": "/**\n * Checks whether one node contains another.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contains: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contains", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#copyState:member", "docComment": "/**\n * Copies a mode state object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copyState: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "copyState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#countColumn:member(1)", "docComment": "/**\n * Finds the column position at a given string index using a given tab size.\n *\n * @param line - The line string.\n *\n * @param index - The string index (or `null` for end of line).\n *\n * @param tabSize - The tab size.\n *\n * @returns The column number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "countColumn(line: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", index: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ", tabSize: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "tabSize", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "countColumn" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#defaults:member", "docComment": "/**\n * Default configuration options for CodeMirror 5 editors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaults: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#defineDocExtension:member(1)", "docComment": "/**\n * Like defineExtension, but the method will be added to Doc objects instead.\n *\n * @param name - The extension name.\n *\n * @param value - The extension implementation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineDocExtension(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "defineDocExtension" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#defineExtension:member(1)", "docComment": "/**\n * Registers a new editor extension method.\n *\n * @param name - The extension name.\n *\n * @param value - The extension implementation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineExtension(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "defineExtension" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#defineInitHook:member(1)", "docComment": "/**\n * Registers a function to be called when an editor is initialized.\n *\n * @param f - The initialization hook function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineInitHook(f: " }, { "kind": "Content", "text": "(cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "defineInitHook" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#defineMIME:member(1)", "docComment": "/**\n * Registers a MIME type with its associated mode specification.\n *\n * @param mime - The MIME type string.\n *\n * @param modeSpec - The mode specification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineMIME(mime: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", modeSpec: " }, { "kind": "Reference", "text": "Cm5ModeSpec", "canonicalReference": "obsidian-typings!Cm5ModeSpec:type" }, { "kind": "Content", "text": "<unknown> | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mime", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "modeSpec", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "defineMIME" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#defineMode:member(1)", "docComment": "/**\n * Registers a new editor mode.\n *\n * @param name - The mode name.\n *\n * @param modeFactory - The factory function that creates the mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineMode<T>(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", modeFactory: " }, { "kind": "Reference", "text": "Cm5ModeFactory", "canonicalReference": "obsidian-typings!Cm5ModeFactory:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "modeFactory", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "defineMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#defineOption:member(1)", "docComment": "/**\n * Registers a new editor option.\n *\n * @param name - The option name.\n *\n * @param defaultValue - The default value for the option.\n *\n * @param onUpdate - The update handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineOption(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", defaultValue: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", onUpdate: " }, { "kind": "Content", "text": "(editor: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ", val: unknown, old: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "defaultValue", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "onUpdate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": false } ], "name": "defineOption" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#Doc:member", "docComment": "/**\n * The CodeMirror 5 `Doc` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Doc: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Doc", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#e_preventDefault:member", "docComment": "/**\n * Prevents the default action of an event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "e_preventDefault: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "e_preventDefault", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#e_stop:member", "docComment": "/**\n * Stops an event (prevents default and stops propagation).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "e_stop: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "e_stop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#e_stopPropagation:member", "docComment": "/**\n * Stops propagation of an event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "e_stopPropagation: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "e_stopPropagation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#extendMode:member(1)", "docComment": "/**\n * Adds or overrides properties on mode objects produced for a specific mode.\n *\n * @param name - The mode name.\n *\n * @param properties - The properties to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extendMode(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", properties: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "properties", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": false } ], "name": "extendMode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#findColumn:member", "docComment": "/**\n * Finds the character offset for a given column.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findColumn: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "findColumn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#findModeByExtension:member", "docComment": "/**\n * Finds a mode spec by file extension.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findModeByExtension: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "findModeByExtension", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#findModeByFileName:member", "docComment": "/**\n * Finds a mode spec by file name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findModeByFileName: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "findModeByFileName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#findModeByMIME:member", "docComment": "/**\n * Finds a mode spec by MIME type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findModeByMIME: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "findModeByMIME", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#findModeByName:member", "docComment": "/**\n * Finds a mode spec by name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findModeByName: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "findModeByName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#fold:member", "docComment": "/**\n * The code-folding helper namespace.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fold: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fold", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#fromTextArea:member(1)", "docComment": "/**\n * Creates a CodeMirror 5 editor from a textarea element.\n *\n * @param host - The textarea element to replace.\n *\n * @param options - Optional editor configuration.\n *\n * @returns The created editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromTextArea(host: " }, { "kind": "Reference", "text": "HTMLTextAreaElement", "canonicalReference": "!HTMLTextAreaElement:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5EditorConfiguration", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "host", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "fromTextArea" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#getMode:member(1)", "docComment": "/**\n * Creates a mode object for the given mode specification.\n *\n * @param config - The editor configuration.\n *\n * @param modeSpec - The mode name or specification.\n *\n * @returns The resolved mode object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMode(config: " }, { "kind": "Reference", "text": "Cm5EditorConfiguration", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration:interface" }, { "kind": "Content", "text": ", modeSpec: " }, { "kind": "Reference", "text": "Cm5ModeSpec", "canonicalReference": "obsidian-typings!Cm5ModeSpec:type" }, { "kind": "Content", "text": "<unknown> | string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "modeSpec", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "getMode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#helpers:member", "docComment": "/**\n * Registered helper namespaces.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "helpers: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "helpers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#Init:member", "docComment": "/**\n * Sentinel value passed as the \"old value\" on the first option update.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Init: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Init", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#innerMode:member(1)", "docComment": "/**\n * Returns the inner mode and its state for the current position.\n *\n * @param mode - The outer mode.\n *\n * @param state - The mode state.\n *\n * @returns An object with the inner mode and state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "innerMode(mode: " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ", state: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5InnerModeResult", "canonicalReference": "obsidian-typings!Cm5InnerModeResult:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "innerMode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#inputStyles:member", "docComment": "/**\n * Registered input-style implementations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputStyles: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputStyles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#isModifierKey:member", "docComment": "/**\n * Checks whether a keyboard event is a modifier keypress.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isModifierKey: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isModifierKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#isWordChar:member(1)", "docComment": "/**\n * Checks whether a character is a word character.\n *\n * @param ch - The character to check.\n *\n * @returns `true` if the character is a word character.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isWordChar(ch: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ch", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isWordChar" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#keyMap:member", "docComment": "/**\n * A map of key map definitions for CodeMirror 5.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyMap: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyMap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#keyName:member", "docComment": "/**\n * Gets the key name for a keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyName: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#keyNames:member", "docComment": "/**\n * A map of key codes to key names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyNames: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyNames", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#Line:member", "docComment": "/**\n * The CodeMirror 5 `Line` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Line: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Line", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#LineWidget:member", "docComment": "/**\n * The CodeMirror 5 `LineWidget` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "LineWidget: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "LineWidget", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#lookupKey:member", "docComment": "/**\n * Looks up a key binding in a keymap.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lookupKey: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lookupKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#mimeModes:member", "docComment": "/**\n * Maps MIME types to mode specifications.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mimeModes: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Cm5ModeSpec", "canonicalReference": "obsidian-typings!Cm5ModeSpec:type" }, { "kind": "Content", "text": "<unknown> | string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mimeModes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#modeExtensions:member", "docComment": "/**\n * Registered mode extensions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modeExtensions: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modeExtensions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#modeInfo:member", "docComment": "/**\n * The list of known mode descriptors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modeInfo: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modeInfo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#modes:member", "docComment": "/**\n * The mode map, mapping mode names to their factory constructors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modes: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Cm5ModeFactory", "canonicalReference": "obsidian-typings!Cm5ModeFactory:interface" }, { "kind": "Content", "text": "<unknown>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#newFoldFunction:member", "docComment": "/**\n * Creates a fold function for a given fold helper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newFoldFunction: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "newFoldFunction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#normalizeKeyMap:member(1)", "docComment": "/**\n * Normalizes a key map, expanding multi-stroke key bindings.\n *\n * @param keymap - The key map to normalize.\n *\n * @returns The normalized key map.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "normalizeKeyMap(keymap: " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "keymap", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "normalizeKeyMap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#off:member(1)", "docComment": "/**\n * Removes an event handler from the given target.\n *\n * @param target - The target object.\n *\n * @param type - The event type.\n *\n * @param f - The event handler to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(target: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", f: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#on:member(1)", "docComment": "/**\n * Registers an event handler on the given target.\n *\n * @param target - The target object.\n *\n * @param type - The event type.\n *\n * @param f - The event handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(target: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", f: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#optionHandlers:member", "docComment": "/**\n * Registered option handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "optionHandlers: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "optionHandlers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#overlayMode:member(1)", "docComment": "/**\n * Utility function to create an overlay mode combining two modes.\n *\n * @param base - The base mode.\n *\n * @param overlay - The overlay mode.\n *\n * @param combine - Whether to combine styles instead of letting overlay win.\n *\n * @returns The combined mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overlayMode(base: " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ", overlay: " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ", combine?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "base", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "overlay", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 }, "isOptional": false }, { "parameterName": "combine", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "overlayMode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#Pass:member", "docComment": "/**\n * A sentinel value that key handlers can return to indicate the binding should fall through.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Pass: " }, { "kind": "Reference", "text": "Cm5Pass", "canonicalReference": "obsidian-typings!Cm5Pass:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Pass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#Pos:member(1)", "docComment": "/**\n * A constructor function for creating {@link Position} objects.\n *\n * @param line - The line number.\n *\n * @param ch - The character position.\n *\n * @param sticky - The sticky direction.\n *\n * @returns The created position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Pos(line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", ch?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", sticky?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ch", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "sticky", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "Pos" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#registerGlobalHelper:member(1)", "docComment": "/**\n * Registers a global helper with a predicate.\n *\n * @param type - The helper type.\n *\n * @param name - The helper name.\n *\n * @param predicate - A predicate function to determine applicability.\n *\n * @param value - The helper implementation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerGlobalHelper(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", predicate: " }, { "kind": "Content", "text": "(mode: " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>, cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ") => boolean" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "predicate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 10 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "name": "registerGlobalHelper" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#registerHelper:member(1)", "docComment": "/**\n * Registers a helper value for a specific type.\n *\n * @param type - The helper type.\n *\n * @param name - The helper name.\n *\n * @param value - The helper implementation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerHelper(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "registerHelper" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#resolveMode:member", "docComment": "/**\n * Resolves a mode spec to a normalized form.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolveMode: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resolveMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#rmClass:member", "docComment": "/**\n * Removes a CSS class from a node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rmClass: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rmClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#scrollbarModel:member", "docComment": "/**\n * Registered scrollbar-model implementations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollbarModel: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scrollbarModel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#SharedTextMarker:member", "docComment": "/**\n * The CodeMirror 5 `SharedTextMarker` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SharedTextMarker: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "SharedTextMarker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#signal:member(1)", "docComment": "/**\n * Fires a signal (event) on the given target.\n *\n * @param target - The target object.\n *\n * @param name - The signal name.\n *\n * @param args - Additional arguments to pass to handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "signal(target: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "signal" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#splitLines:member(1)", "docComment": "/**\n * Splits a string by newline characters.\n *\n * @param text - The text to split.\n *\n * @returns An array of lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "splitLines(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "splitLines" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#startState:member(1)", "docComment": "/**\n * Calls startState of the mode if available, otherwise returns `true`.\n *\n * @param mode - The mode.\n *\n * @returns The initial state, or `true` if no startState method exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startState<T>(mode: " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean | T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "startState" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#StringStream:member", "docComment": "/**\n * The CodeMirror 5 `StringStream` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "StringStream: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "StringStream", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#TextMarker:member", "docComment": "/**\n * The CodeMirror 5 `TextMarker` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TextMarker: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TextMarker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#version:member", "docComment": "/**\n * The CodeMirror 5 version string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#Vim:member", "docComment": "/**\n * The CodeMirror 5 Vim-mode API.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Vim: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Vim", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CodeMirrorModule#wheelEventPixels:member", "docComment": "/**\n * Computes pixel deltas for a wheel event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wheelEventPixels: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wheelEventPixels", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ColorSource:type", "docComment": "/**\n * Color source type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorSource = " }, { "kind": "Content", "text": "{ r: number; g: number; b: number; a?: number } | " }, { "kind": "Reference", "text": "Float32Array", "canonicalReference": "!Float32Array:interface" }, { "kind": "Content", "text": " | number | number[] | string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/ColorSource.d.ts", "releaseTag": "Public", "name": "ColorSource", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CommandPaletteModal:interface", "docComment": "/**\n * Fuzzy suggest modal used by the command palette to search and execute commands.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CommandPaletteModal extends " }, { "kind": "Reference", "text": "FuzzySuggestModal", "canonicalReference": "obsidian!FuzzySuggestModal:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/command-palette/CommandPaletteModal.d.ts", "releaseTag": "Public", "name": "CommandPaletteModal", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPaletteModal#commands:member", "docComment": "/**\n * Cached list of available commands, or `null` if not yet populated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commands: " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": "[] | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "commands", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPaletteModal#plugin:member", "docComment": "/**\n * Reference to the command palette plugin instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "CommandPalettePluginInstance", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CommandPaletteOptions:interface", "docComment": "/**\n * Configuration options for the command palette plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CommandPaletteOptions " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/command-palette/CommandPaletteOptions.d.ts", "releaseTag": "Public", "name": "CommandPaletteOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPaletteOptions#pinned:member", "docComment": "/**\n * List of pinned command IDs that appear at the top of the palette.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pinned: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pinned", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CommandPalettePlugin:interface", "docComment": "/**\n * Internal plugin registration for the command palette feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CommandPalettePlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CommandPalettePluginInstance", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/command-palette/CommandPalettePlugin.d.ts", "releaseTag": "Public", "name": "CommandPalettePlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance:interface", "docComment": "/**\n * Plugin instance for the command palette, providing the fuzzy command search modal.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CommandPalettePluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CommandPalettePlugin", "canonicalReference": "obsidian-typings!CommandPalettePlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/command-palette/CommandPalettePluginInstance.d.ts", "releaseTag": "Public", "name": "CommandPalettePluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#getCommands:member(1)", "docComment": "/**\n * Get the list of available commands for the palette.\n *\n * @returns The available commands.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCommands(): " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCommands" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#modal:member", "docComment": "/**\n * The command palette fuzzy suggest modal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modal: " }, { "kind": "Reference", "text": "CommandPaletteModal", "canonicalReference": "obsidian-typings!CommandPaletteModal:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Handle external settings file changes and reload configuration.\n *\n * @returns A promise that resolves when the settings are reloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#onOpen:member(1)", "docComment": "/**\n * Called when the command palette is opened.\n *\n * @returns Whether the command palette was successfully opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onOpen(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#openCallback:member(1)", "docComment": "/**\n * Callback invoked to open the command palette.\n *\n * @returns Whether the callback was successfully executed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openCallback(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "openCallback" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#options:member", "docComment": "/**\n * Configuration options for the command palette.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "CommandPaletteOptions", "canonicalReference": "obsidian-typings!CommandPaletteOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#plugin:member", "docComment": "/**\n * Reference to the command palette plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "CommandPalettePlugin", "canonicalReference": "obsidian-typings!CommandPalettePlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#recentCommands:member", "docComment": "/**\n * List of recently used command IDs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "recentCommands: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "recentCommands", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance#saveSettings:member(1)", "docComment": "/**\n * Save the command palette settings.\n *\n * @param plugin - The command palette plugin to save settings for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveSettings(plugin: " }, { "kind": "Reference", "text": "CommandPalettePlugin", "canonicalReference": "obsidian-typings!CommandPalettePlugin:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "plugin", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "saveSettings" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Commands:interface", "docComment": "/**\n * Manager for registering, finding, and executing commands.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Commands extends " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/commands/Commands.d.ts", "releaseTag": "Public", "name": "Commands", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Commands#addCommand:member(1)", "docComment": "/**\n * Add a command to the command registry.\n *\n * @param command - Command to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addCommand(command: " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addCommand" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Commands#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Commands#commands:member", "docComment": "/**\n * Commands *without* editor callback, will always be available in the command palette.\n *\n * @example\n *\n * `app:open-vault` or `app:reload`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commands: " }, { "kind": "Reference", "text": "CommandsCommandsRecord", "canonicalReference": "obsidian-typings!CommandsCommandsRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "commands", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Commands#constructor2__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getCommandsConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor2__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor2__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Commands#editorCommands:member", "docComment": "/**\n * Commands *with* editor callback, will only be available when editor is active and callback returns `true`.\n *\n * @example\n *\n * `editor:fold-all` or `command-palette:open`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editorCommands: " }, { "kind": "Reference", "text": "CommandsEditorCommandsRecord", "canonicalReference": "obsidian-typings!CommandsEditorCommandsRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "editorCommands", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Commands#executeCommand:member(1)", "docComment": "/**\n * Execute a command by reference.\n *\n * @param command - {@link obsidian#Command} to execute.\n *\n * @returns Whether the command was successfully executed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeCommand(command: " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": ", event?: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "executeCommand" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Commands#executeCommandById:member(1)", "docComment": "/**\n * Execute a command by ID.\n *\n * @param commandId - ID of command to execute.\n *\n * @returns Whether the command was successfully executed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeCommandById(commandId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", event?: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "commandId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "executeCommandById" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Commands#findCommand:member(1)", "docComment": "/**\n * Find a command by ID.\n *\n * @param commandId - ID of command to find.\n *\n * @returns The command, or `undefined` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findCommand(commandId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "commandId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "findCommand" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Commands#listCommands:member(1)", "docComment": "/**\n * Lists **all** commands, both with and without editor callback.\n *\n * @returns All registered commands.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "listCommands(): " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "listCommands" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Commands#removeCommand:member(1)", "docComment": "/**\n * Remove a command from the command registry.\n *\n * @param commandId - ID of command to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeCommand(commandId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "commandId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeCommand" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!commands:var", "docComment": "/**\n * A map of built-in CodeMirror 5 commands.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commands: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, (cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ") => void>" } ], "fileUrlPath": "src/codemirror/internals/vars/commands.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "commands", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CommandsCommandsRecord:interface", "docComment": "/**\n * Record mapping command IDs to {@link obsidian#Command} objects without editor callbacks.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CommandsCommandsRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/commands/CommandsCommandsRecord.d.ts", "releaseTag": "Public", "name": "CommandsCommandsRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CommandsEditorCommandsRecord:interface", "docComment": "/**\n * Record mapping command IDs to {@link obsidian#Command} objects with editor callbacks.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CommandsEditorCommandsRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/commands/CommandsEditorCommandsRecord.d.ts", "releaseTag": "Public", "name": "CommandsEditorCommandsRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ConcatFunction:interface", "docComment": "/**\n * Function `Concat`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConcatFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/ConcatFunction.d.ts", "releaseTag": "Public", "name": "ConcatFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Config:interface", "docComment": "/**\n * Configuration options for DOMPurify sanitization.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Config " } ], "fileUrlPath": "src/dompurify/internals/Config.d.ts", "releaseTag": "Public", "name": "Config", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ADD_ATTR:member", "docComment": "/**\n * Additional attributes to allow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ADD_ATTR?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ADD_ATTR", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ADD_DATA_URI_TAGS:member", "docComment": "/**\n * Additional data URI tags to allow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ADD_DATA_URI_TAGS?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ADD_DATA_URI_TAGS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ADD_TAGS:member", "docComment": "/**\n * Additional tags to allow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ADD_TAGS?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ADD_TAGS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ADD_URI_SAFE_ATTR:member", "docComment": "/**\n * Additional URI-safe attributes to allow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ADD_URI_SAFE_ATTR?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ADD_URI_SAFE_ATTR", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ALLOW_ARIA_ATTR:member", "docComment": "/**\n * Whether to allow ARIA attributes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ALLOW_ARIA_ATTR?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ALLOW_ARIA_ATTR", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ALLOW_DATA_ATTR:member", "docComment": "/**\n * Whether to allow data attributes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ALLOW_DATA_ATTR?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ALLOW_DATA_ATTR", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ALLOW_UNKNOWN_PROTOCOLS:member", "docComment": "/**\n * Whether to allow unknown protocols in URLs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ALLOW_UNKNOWN_PROTOCOLS?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ALLOW_UNKNOWN_PROTOCOLS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ALLOWED_ATTR:member", "docComment": "/**\n * List of allowed attributes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ALLOWED_ATTR?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ALLOWED_ATTR", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ALLOWED_NAMESPACES:member", "docComment": "/**\n * List of allowed namespaces.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ALLOWED_NAMESPACES?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ALLOWED_NAMESPACES", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ALLOWED_TAGS:member", "docComment": "/**\n * List of allowed tags.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ALLOWED_TAGS?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ALLOWED_TAGS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#ALLOWED_URI_REGEXP:member", "docComment": "/**\n * Regular expression for allowed URI patterns.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ALLOWED_URI_REGEXP?: " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ALLOWED_URI_REGEXP", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#CUSTOM_ELEMENT_HANDLING:member", "docComment": "/**\n * Custom element handling configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "CUSTOM_ELEMENT_HANDLING?: " }, { "kind": "Reference", "text": "CustomElementHandling", "canonicalReference": "obsidian-typings!CustomElementHandling:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "CUSTOM_ELEMENT_HANDLING", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#FORBID_ATTR:member", "docComment": "/**\n * List of forbidden attributes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FORBID_ATTR?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "FORBID_ATTR", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#FORBID_CONTENTS:member", "docComment": "/**\n * List of forbidden content types.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FORBID_CONTENTS?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "FORBID_CONTENTS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#FORBID_TAGS:member", "docComment": "/**\n * List of forbidden tags.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FORBID_TAGS?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "FORBID_TAGS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#FORCE_BODY:member", "docComment": "/**\n * Whether to force the use of the body element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FORCE_BODY?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "FORCE_BODY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#IN_PLACE:member", "docComment": "/**\n * Whether to sanitize in place.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "IN_PLACE?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "IN_PLACE", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#KEEP_CONTENT:member", "docComment": "/**\n * Whether to keep content of removed elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "KEEP_CONTENT?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "KEEP_CONTENT", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#NAMESPACE:member", "docComment": "/**\n * Namespace for the parsed document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "NAMESPACE?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "NAMESPACE", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#PARSER_MEDIA_TYPE:member", "docComment": "/**\n * Media type for the parser.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "PARSER_MEDIA_TYPE?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "PARSER_MEDIA_TYPE", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#RETURN_DOM_FRAGMENT:member", "docComment": "/**\n * Whether to return a DocumentFragment instead of a string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RETURN_DOM_FRAGMENT?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "RETURN_DOM_FRAGMENT", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#RETURN_DOM_IMPORT:member", "docComment": "/**\n * Whether to import the returned DOM node into the current document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RETURN_DOM_IMPORT?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "RETURN_DOM_IMPORT", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#RETURN_DOM:member", "docComment": "/**\n * Whether to return a DOM node instead of a string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RETURN_DOM?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "RETURN_DOM", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#RETURN_TRUSTED_TYPE:member", "docComment": "/**\n * Whether to return a Trusted Type object instead of a string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RETURN_TRUSTED_TYPE?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "RETURN_TRUSTED_TYPE", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#SAFE_FOR_TEMPLATES:member", "docComment": "/**\n * Whether to enable safe-for-templates mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SAFE_FOR_TEMPLATES?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "SAFE_FOR_TEMPLATES", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#SANITIZE_DOM:member", "docComment": "/**\n * Whether to sanitize DOM clobbering attacks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SANITIZE_DOM?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "SANITIZE_DOM", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#SANITIZE_NAMED_PROPS:member", "docComment": "/**\n * Whether to sanitize named properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SANITIZE_NAMED_PROPS?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "SANITIZE_NAMED_PROPS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#USE_PROFILES:member", "docComment": "/**\n * Profiles to use for sanitization.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "USE_PROFILES?: " }, { "kind": "Reference", "text": "ConfigUseProfiles", "canonicalReference": "obsidian-typings!ConfigUseProfiles:interface" }, { "kind": "Content", "text": " | false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "USE_PROFILES", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Config#WHOLE_DOCUMENT:member", "docComment": "/**\n * Whether to sanitize the whole document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "WHOLE_DOCUMENT?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "WHOLE_DOCUMENT", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ConfigItem:type", "docComment": "/**\n * Union type of all valid configuration item keys in the vault config.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ConfigItem =\n " }, { "kind": "Content", "text": "| 'accentColor'\n | 'alwaysUpdateLinks'\n | 'attachmentFolderPath'\n | 'autoConvertHtml'\n | 'autoPairBrackets'\n | 'autoPairMarkdown'\n | 'baseFontSize'\n | 'baseFontSizeAction'\n | 'cssTheme'\n | 'defaultViewMode'\n | 'enabledCssSnippets'\n | 'focusNewTab'\n | 'foldHeading'\n | 'foldIndent'\n | 'hotkeys'\n | 'interfaceFontFamily'\n | 'livePreview'\n | 'mobilePullAction'\n | 'mobileQuickRibbonItem'\n | 'mobileToolbarCommands'\n | 'monospaceFontFamily'\n | 'nativeMenus'\n | 'newFileFolderPath'\n | 'newFileLocation'\n | 'newLinkFormat'\n | 'pdfExportSettings'\n | 'promptDelete'\n | 'propertiesInDocument'\n | 'readableLineLength'\n | 'rightToLeft'\n | 'showIndentGuide'\n | 'showInlineTitle'\n | 'showLineNumber'\n | 'showRibbon'\n | 'showUnsupportedFiles'\n | 'showViewHeader'\n | 'smartIndentList'\n | 'spellcheck'\n | 'spellcheckLanguages'\n | 'strictLineBreaks'\n | 'tabSize'\n | 'textFontFamily'\n | 'theme'\n | 'translucency'\n | 'trashOption'\n | 'types'\n | 'uriCallbacks'\n | 'useMarkdownLinks'\n | 'userIgnoreFilters'\n | 'useTab'\n | 'vimMode'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/ConfigItem.d.ts", "releaseTag": "Public", "name": "ConfigItem", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ConfigReturnDom:interface", "docComment": "/**\n * Configuration override to return a DOM node.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConfigReturnDom " } ], "fileUrlPath": "src/dompurify/internals/ConfigReturnDom.d.ts", "releaseTag": "Public", "name": "ConfigReturnDom", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ConfigReturnDom#RETURN_DOM:member", "docComment": "/**\n * Whether to return a DOM node instead of a string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RETURN_DOM: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "RETURN_DOM", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ConfigReturnDomFragment:interface", "docComment": "/**\n * Configuration override to return a DocumentFragment.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConfigReturnDomFragment " } ], "fileUrlPath": "src/dompurify/internals/ConfigReturnDomFragment.d.ts", "releaseTag": "Public", "name": "ConfigReturnDomFragment", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ConfigReturnDomFragment#RETURN_DOM_FRAGMENT:member", "docComment": "/**\n * Whether to return a DocumentFragment instead of a string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RETURN_DOM_FRAGMENT: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "RETURN_DOM_FRAGMENT", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ConfigUseProfiles:interface", "docComment": "/**\n * Sanitization profile options for DOMPurify.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConfigUseProfiles " } ], "fileUrlPath": "src/dompurify/internals/ConfigUseProfiles.d.ts", "releaseTag": "Public", "name": "ConfigUseProfiles", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ConfigUseProfiles#html:member", "docComment": "/**\n * Whether to allow HTML elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "html?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "html", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ConfigUseProfiles#mathMl:member", "docComment": "/**\n * Whether to allow MathML elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mathMl?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mathMl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ConfigUseProfiles#svg:member", "docComment": "/**\n * Whether to allow SVG elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "svg?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "svg", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ConfigUseProfiles#svgFilters:member", "docComment": "/**\n * Whether to allow SVG filter elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "svgFilters?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "svgFilters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ConstructorBase:interface", "docComment": "/**\n * Base type representing a constructor function that creates instances of the given type.\n *\n * @typeParam Args - The constructor argument types.\n *\n * @typeParam Instance - The type of the constructed instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConstructorBase<Args extends " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ", Instance> " } ], "fileUrlPath": "src/obsidian/internals/constructors/ConstructorBase.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Args", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Instance", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ConstructorBase", "preserveMemberOrder": false, "members": [ { "kind": "ConstructSignature", "canonicalReference": "obsidian-typings!ConstructorBase:new(1)", "docComment": "/**\n * Construct a new instance with the given arguments.\n *\n * @param args - The constructor arguments.\n *\n * @returns The constructed instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "new (...args: " }, { "kind": "Content", "text": "Args" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "Instance" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ConstructorBase#prototype:member", "docComment": "/**\n * Prototype of the constructed instances.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prototype: " }, { "kind": "Content", "text": "Instance" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "prototype", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!Container:class", "docComment": "/**\n * Container for display objects.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Container<T extends " }, { "kind": "Reference", "text": "DisplayObject", "canonicalReference": "obsidian-typings!DisplayObject:class" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "DisplayObject", "canonicalReference": "obsidian-typings!DisplayObject:class" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "DisplayObject", "canonicalReference": "obsidian-typings!DisplayObject:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/pixi.js/internals/Container.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "isAbstract": false, "name": "Container", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "obsidian-typings!Container#addChild:member(1)", "docComment": "/**\n * Adds one or more children to the container.\n *\n * @param children - Children to add.\n *\n * @returns The first child added.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addChild<U extends " }, { "kind": "Content", "text": "T[]" }, { "kind": "Content", "text": ">(...children: " }, { "kind": "Content", "text": "U" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "U[0]" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "U", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "children", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addChild" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#addChildAt:member(1)", "docComment": "/**\n * Adds a child at a specific index.\n *\n * @param child - Child to add.\n *\n * @param index - Index to insert at.\n *\n * @returns The child added.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addChildAt<U extends " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ">(child: " }, { "kind": "Content", "text": "U" }, { "kind": "Content", "text": ", index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "U" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "U", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "child", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addChildAt" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Container#children:member", "docComment": "/**\n * Children of this container (read-only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly children: " }, { "kind": "Content", "text": "T[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#destroy:member(1)", "docComment": "/**\n * Destroys this container.\n *\n * @param options - Destroy options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(options?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "IDestroyOptions", "canonicalReference": "obsidian-typings!IDestroyOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#getChildAt:member(1)", "docComment": "/**\n * Returns the child at the given index.\n *\n * @param index - Index of the child.\n *\n * @returns The child at the index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getChildAt(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getChildAt" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#getChildIndex:member(1)", "docComment": "/**\n * Returns the index of a child.\n *\n * @param child - The child to find.\n *\n * @returns The index of the child.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getChildIndex(child: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "child", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getChildIndex" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Container#height:member", "docComment": "/**\n * Height of the container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get height(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";\n\nset height(value: number);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Container#parent:member", "docComment": "/**\n * Parent container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent: " }, { "kind": "Reference", "text": "Container", "canonicalReference": "obsidian-typings!Container:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#removeChild:member(1)", "docComment": "/**\n * Removes one or more children from the container.\n *\n * @param children - Children to remove.\n *\n * @returns The first child removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeChild<U extends " }, { "kind": "Content", "text": "T[]" }, { "kind": "Content", "text": ">(...children: " }, { "kind": "Content", "text": "U" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "U[0]" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "U", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "children", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeChild" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#removeChildAt:member(1)", "docComment": "/**\n * Removes the child at a specific index.\n *\n * @param index - Index of the child to remove.\n *\n * @returns The removed child.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeChildAt(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeChildAt" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#removeChildren:member(1)", "docComment": "/**\n * Removes children from the container.\n *\n * @param beginIndex - Start index.\n *\n * @param endIndex - End index.\n *\n * @returns The removed children.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeChildren(beginIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", endIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "beginIndex", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "endIndex", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "removeChildren" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#setChildIndex:member(1)", "docComment": "/**\n * Sets the index of a child.\n *\n * @param child - The child.\n *\n * @param index - The new index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setChildIndex(child: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ", index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "child", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setChildIndex" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Container#sortableChildren:member", "docComment": "/**\n * Whether children should be sorted by zIndex.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sortableChildren: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sortableChildren", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!Container#sortChildren:member(1)", "docComment": "/**\n * Sorts the children by zIndex.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sortChildren(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "sortChildren" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Container#sortDirty:member", "docComment": "/**\n * Whether the children need sorting.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sortDirty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sortDirty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Container#width:member", "docComment": "/**\n * Width of the container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get width(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";\n\nset width(value: number);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 5, "endIndex": 6 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ContainsAllFunction:interface", "docComment": "/**\n * Function `ContainsAll`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ContainsAllFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/ContainsAllFunction.d.ts", "releaseTag": "Public", "name": "ContainsAllFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ContainsAnyFunction:interface", "docComment": "/**\n * Function `ContainsAny`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ContainsAnyFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/ContainsAnyFunction.d.ts", "releaseTag": "Public", "name": "ContainsAnyFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ContainsFunction:interface", "docComment": "/**\n * Function `Contains`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ContainsFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/ContainsFunction.d.ts", "releaseTag": "Public", "name": "ContainsFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ContainsNoneFunction:interface", "docComment": "/**\n * Function `ContainsNone`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ContainsNoneFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/ContainsNoneFunction.d.ts", "releaseTag": "Public", "name": "ContainsNoneFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ContentPosition:type", "docComment": "/**\n * Represents a content position as a start and end offset pair within a document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ContentPosition = " }, { "kind": "Content", "text": "[startOffset: number, endOffset: number]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/tree/ContentPosition.d.ts", "releaseTag": "Public", "name": "ContentPosition", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Coords:interface", "docComment": "/**\n * Represents a bounding rectangle with top, bottom, left, and right coordinates.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Coords " } ], "fileUrlPath": "src/@codemirror__view/internals/Coords.d.ts", "releaseTag": "Public", "name": "Coords", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Coords#bottom:member", "docComment": "/**\n * Bottom edge coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Coords#left:member", "docComment": "/**\n * Left edge coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Coords#right:member", "docComment": "/**\n * Right edge coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "right: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Coords#top:member", "docComment": "/**\n * Top edge coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CoordsLeftTop:interface", "docComment": "/**\n * Left and top coordinates.\n *\n * @unofficial\n *\n * @since\n *\n * 0.11.11\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CoordsLeftTop " } ], "fileUrlPath": "src/obsidian/internals/CoordsLeftTop.d.ts", "releaseTag": "Public", "name": "CoordsLeftTop", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CoordsLeftTop#left:member", "docComment": "/**\n * Left coordinate\n *\n * @since\n *\n * 0.11.11\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CoordsLeftTop#top:member", "docComment": "/**\n * Top coordinate\n *\n * @since\n *\n * 0.11.11\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!createInstance:var", "docComment": "/**\n * Creates a new i18next instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createInstance: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['createInstance']" } ], "fileUrlPath": "src/i18next/internals/functions/createInstance.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "createInstance", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Function", "canonicalReference": "obsidian-typings!createTFileInstance:function(1)", "docComment": "/**\n * Creates and properly initializes the instance of {@link obsidian#TFile} even the underlying file does not exist. This doesn't create the missing file on the file system.\n *\n * @param app - The Obsidian app instance.\n *\n * @param path - The path to the file.\n *\n * @returns The created {@link obsidian#TFile} instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTFileInstance(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/functions/createTFileInstance.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "createTFileInstance" }, { "kind": "Function", "canonicalReference": "obsidian-typings!createTFolderInstance:function(1)", "docComment": "/**\n * Creates and properly initializes the instance of {@link obsidian#TFolder} even the underlying folder does not exist. This doesn't create the missing folder on the file system.\n *\n * @param app - The Obsidian app instance.\n *\n * @param path - The path to the folder.\n *\n * @returns The created {@link obsidian#TFolder} instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTFolderInstance(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/functions/createTFolderInstance.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "createTFolderInstance" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CustomArrayDict:interface", "docComment": "/**\n * A dictionary mapping string keys to arrays of values.\n *\n * @typeParam T - The type of the values.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomArrayDict<T> " } ], "fileUrlPath": "src/obsidian/internals/collections/CustomArrayDict.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "CustomArrayDict", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomArrayDict#add:member(1)", "docComment": "/**\n * Add a value to the array associated with the given key.\n *\n * @param key - The key.\n *\n * @param value - The value to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "add" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomArrayDict#clear:member(1)", "docComment": "/**\n * Remove all values for the given key.\n *\n * @param key - The key to clear.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomArrayDict#clearAll:member(1)", "docComment": "/**\n * Remove all keys and their values.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomArrayDict#contains:member(1)", "docComment": "/**\n * Check whether the array for the given key contains the specified value.\n *\n * @param key - The key.\n *\n * @param value - The value to check.\n *\n * @returns Whether the value exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contains(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "contains" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomArrayDict#count:member(1)", "docComment": "/**\n * Get the total number of values across all keys.\n *\n * @returns Total value count.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "count(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "count" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomArrayDict#data:member", "docComment": "/**\n * Internal map storing key-to-array mappings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<string, T[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomArrayDict#get:member(1)", "docComment": "/**\n * Get the array of values for the given key, or `null` if not found.\n *\n * @param key - The key.\n *\n * @returns Array of values, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | T[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomArrayDict#keys:member(1)", "docComment": "/**\n * Get all keys in the dictionary.\n *\n * @returns Array of keys.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keys(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "keys" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomArrayDict#remove:member(1)", "docComment": "/**\n * Remove a specific value from the array associated with the given key.\n *\n * @param key - The key.\n *\n * @param value - The value to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "remove" } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!CustomArrayDictImpl:class", "docComment": "/**\n * A dictionary that maps string keys to arrays of unique values, implementing {@link CustomArrayDict}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class CustomArrayDictImpl<T> implements " }, { "kind": "Reference", "text": "CustomArrayDict", "canonicalReference": "obsidian-typings!CustomArrayDict:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/implementations/classes/CustomArrayDictImpl.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isAbstract": false, "name": "CustomArrayDictImpl", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#add:member(1)", "docComment": "/**\n * Add a value to the array associated with the given key.\n *\n * @param key - The key.\n *\n * @param value - The value to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "add" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#clear:member(1)", "docComment": "/**\n * Remove all values for the given key.\n *\n * @param key - The key to clear.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "clear" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#clearAll:member(1)", "docComment": "/**\n * Remove all keys and their values.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "clearAll" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#contains:member(1)", "docComment": "/**\n * Check whether the array for the given key contains the specified value.\n *\n * @param key - The key.\n *\n * @param value - The value to check.\n *\n * @returns Whether the value exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contains(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "contains" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#count:member(1)", "docComment": "/**\n * Get the total number of values across all keys.\n *\n * @returns Total value count.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "count(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "count" }, { "kind": "Property", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#data:member", "docComment": "/**\n * Internal map storing key-to-array mappings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<string, T[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#get:member(1)", "docComment": "/**\n * Get the array of values for the given key, or `null` if not found.\n *\n * @param key - The key.\n *\n * @returns Array of values, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | T[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "get" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#keys:member(1)", "docComment": "/**\n * Get all keys in the dictionary.\n *\n * @returns Array of keys.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keys(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "keys" }, { "kind": "Method", "canonicalReference": "obsidian-typings!CustomArrayDictImpl#remove:member(1)", "docComment": "/**\n * Remove a specific value from the array associated with the given key.\n *\n * @param key - The key.\n *\n * @param value - The value to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "remove" } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CustomCSS:interface", "docComment": "/**\n * Manager for custom CSS themes and snippets.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomCSS extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/custom-css/CustomCSS.d.ts", "releaseTag": "Public", "name": "CustomCSS", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#boundRaw:member(1)", "docComment": "/**\n * Bound callback for handling raw file change events for a theme.\n *\n * @param themeName - Name of the theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "boundRaw(themeName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "themeName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "boundRaw" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#checkForUpdate:member(1)", "docComment": "/**\n * Check whether a specific theme can be updated.\n *\n * @param themeName - Name of the theme to check.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkForUpdate(themeName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "themeName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "checkForUpdate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#checkForUpdates:member(1)", "docComment": "/**\n * Check all themes for updates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkForUpdates(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "checkForUpdates" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#constructor2__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getCustomCSSConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor2__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor2__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#csscache:member", "docComment": "/**\n * Cache of CSS snippet filepath (relative to vault root) to CSS snippet contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "csscache: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "csscache", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#disableTranslucency:member(1)", "docComment": "/**\n * Disable translucency of application background.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableTranslucency(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "disableTranslucency" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#downloadLegacyTheme:member(1)", "docComment": "/**\n * Fetch legacy theme CSS using the pre-v1.0.0 theme download pipeline.\n *\n * @param options - Options for downloading the legacy theme.\n *\n * @returns String obsidian.css contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadLegacyTheme(options: " }, { "kind": "Reference", "text": "DownloadLegacyThemeOptions", "canonicalReference": "obsidian-typings!DownloadLegacyThemeOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "downloadLegacyTheme" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#enabledSnippets:member", "docComment": "/**\n * Set of enabled snippet, given by filenames.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabledSnippets: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enabledSnippets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#enableTranslucency:member(1)", "docComment": "/**\n * Enable translucency of application background.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableTranslucency(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "enableTranslucency" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#extraStyleEls:member", "docComment": "/**\n * Contains references to Style elements containing custom CSS snippets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extraStyleEls: " }, { "kind": "Reference", "text": "HTMLStyleElement", "canonicalReference": "!HTMLStyleElement:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "extraStyleEls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#getManifest:member(1)", "docComment": "/**\n * Fetch a theme's manifest using repository URL.\n *\n * @param repoUrl - Repository URL (e.g. `username/repo`).\n *\n * @returns The theme manifest.\n *\n * @remark\n *\n * Do **not** include github prefix, only `username/repo`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getManifest(repoUrl: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ThemeManifest", "canonicalReference": "obsidian-typings!ThemeManifest:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "repoUrl", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getManifest" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#getSnippetPath:member(1)", "docComment": "/**\n * Convert snippet name to its corresponding filepath (relative to vault root).\n *\n * @param snippetName - Name of the snippet.\n *\n * @returns String `.obsidian/snippets/${snippetName}.css`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSnippetPath(snippetName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "snippetName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSnippetPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#getSnippetsFolder:member(1)", "docComment": "/**\n * Returns the folder path where snippets are stored (relative to vault root).\n *\n * @returns Path to the snippets folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSnippetsFolder(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSnippetsFolder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#getThemeFolder:member(1)", "docComment": "/**\n * Returns the folder path where themes are stored (relative to vault root).\n *\n * @returns Path to the themes folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getThemeFolder(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getThemeFolder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#getThemePath:member(1)", "docComment": "/**\n * Convert theme name to its corresponding filepath (relative to vault root).\n *\n * @param themeName - Name of the theme.\n *\n * @returns String `.obsidian/themes/${themeName}/theme.css`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getThemePath(themeName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "themeName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getThemePath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#hasUpdates:member(1)", "docComment": "/**\n * Returns whether there are themes that can be updated.\n *\n * @returns Whether any themes have available updates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasUpdates(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hasUpdates" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#installLegacyTheme:member(1)", "docComment": "/**\n * Install a legacy theme using the pre-v1.0.0 theme download pipeline<br> Will create a corresponding. dummy manifest for the theme.\n *\n * @param options - Options for installing the theme.\n *\n * @returns A promise that resolves when the legacy theme is installed.\n *\n * @remark\n *\n * Name will be used as the folder name for the theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "installLegacyTheme(options: " }, { "kind": "Reference", "text": "InstallThemeOptions", "canonicalReference": "obsidian-typings!InstallThemeOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "installLegacyTheme" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#installTheme:member(1)", "docComment": "/**\n * Install a theme using the regular theme download pipeline.\n *\n * @param options - Options for installing the theme.\n *\n * @param version - Version to install.\n *\n * @returns A promise that resolves when the theme is installed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "installTheme(options: " }, { "kind": "Reference", "text": "InstallThemeOptions", "canonicalReference": "obsidian-typings!InstallThemeOptions:interface" }, { "kind": "Content", "text": ", version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "version", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "installTheme" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#isDarkMode:member(1)", "docComment": "/**\n * Check whether the current theme is dark mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDarkMode(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isDarkMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#isThemeInstalled:member(1)", "docComment": "/**\n * Check whether a specific theme is installed by theme name.\n *\n * @param themeName - Name of the theme.\n *\n * @returns Whether the theme is installed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isThemeInstalled(themeName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "themeName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isThemeInstalled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#loadCss:member(1)", "docComment": "/**\n * Load and apply CSS from the given source.\n *\n * @returns The result of loading CSS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadCss(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "loadCss" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#loadData:member(1)", "docComment": "/**\n * Load stored {@link CustomCSS} configuration data.\n *\n * @returns The loaded configuration data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadData(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#loadSnippets:member(1)", "docComment": "/**\n * Load and apply all enabled CSS snippets.\n *\n * @returns The result of loading snippets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadSnippets(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadSnippets" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#loadTheme:member(1)", "docComment": "/**\n * Load and apply a specific theme.\n *\n * @returns The result of loading the theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadTheme(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "loadTheme" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#oldThemes:member", "docComment": "/**\n * List of theme names not fully updated to post v1.0.0 theme guidelines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "oldThemes: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "oldThemes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#onload:member(1)", "docComment": "/**\n * Lifecycle hook called when the component is loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#onRaw:member(1)", "docComment": "/**\n * Handle raw file system change events for a theme.\n *\n * @param themeName - Name of the theme that changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRaw(themeName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "themeName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onRaw" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#queue:member", "docComment": "/**\n * Queue for sequential CSS processing operations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queue: " }, { "kind": "Reference", "text": "PromisedQueue", "canonicalReference": "obsidian-typings!PromisedQueue:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#readSnippets:member(1)", "docComment": "/**\n * Read available CSS snippets from the snippets folder.\n *\n * @param reload - Whether to reload snippets after reading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readSnippets(reload?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reload", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "readSnippets" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#readThemes:member(1)", "docComment": "/**\n * Read available themes from the themes folder.\n *\n * @param reload - Whether to reload themes after reading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readThemes(reload?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reload", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "readThemes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#reloadTheme:member(1)", "docComment": "/**\n * Reload the active theme CSS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reloadTheme(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reloadTheme" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#removeTheme:member(1)", "docComment": "/**\n * Remove a theme by theme name.\n *\n * @param themeName - Name of the theme to remove.\n *\n * @returns A promise that resolves when the theme is removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeTheme(themeName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "themeName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeTheme" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#requestLoadSnippets:member", "docComment": "/**\n * Debounced function to reload CSS snippets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestLoadSnippets: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestLoadSnippets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#requestLoadTheme:member", "docComment": "/**\n * Debounced function to reload the active theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestLoadTheme: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestLoadTheme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#requestReadThemes:member", "docComment": "/**\n * Debounced function to re-read available themes from disk.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestReadThemes: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestReadThemes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#setCssEnabledStatus:member(1)", "docComment": "/**\n * Set the activation status of a snippet by snippet name.\n *\n * @param snippetName - Name of the snippet.\n *\n * @param enabled - Whether the snippet should be enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCssEnabledStatus(snippetName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "snippetName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "enabled", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setCssEnabledStatus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#setTheme:member(1)", "docComment": "/**\n * Set the active theme by theme name.\n *\n * @param themeName - Name of the theme to activate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTheme(themeName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "themeName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setTheme" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!CustomCSS#setTranslucency:member(1)", "docComment": "/**\n * Set the translucency of application background.\n *\n * @param translucency - Whether translucency should be enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTranslucency(translucency: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "translucency", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setTranslucency" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#snippets:member", "docComment": "/**\n * List of snippets detected by Obsidian, given by their filenames.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "snippets: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "snippets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#styleEl:member", "docComment": "/**\n * Main style element for the active theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "styleEl: " }, { "kind": "Reference", "text": "HTMLStyleElement", "canonicalReference": "!HTMLStyleElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "styleEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#theme:member", "docComment": "/**\n * Currently active theme, given by its name.\n *\n * @remark\n *\n * is the default Obsidian theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "theme: " }, { "kind": "Content", "text": "'' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "theme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#themes:member", "docComment": "/**\n * Mapping of theme names to their manifest.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "themes: " }, { "kind": "Reference", "text": "CustomCSSThemesRecord", "canonicalReference": "obsidian-typings!CustomCSSThemesRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "themes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomCSS#updates:member", "docComment": "/**\n * Record of available theme updates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updates: " }, { "kind": "Reference", "text": "CustomCSSUpdatesRecord", "canonicalReference": "obsidian-typings!CustomCSSUpdatesRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "updates", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CustomCSSThemesRecord:interface", "docComment": "/**\n * Record mapping theme names to their manifest metadata.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomCSSThemesRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "ThemeManifest", "canonicalReference": "obsidian-typings!ThemeManifest:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/custom-css/CustomCSSThemesRecord.d.ts", "releaseTag": "Public", "name": "CustomCSSThemesRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CustomCSSUpdatesRecord:interface", "docComment": "/**\n * Record mapping theme names to their available update information.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomCSSUpdatesRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/custom-css/CustomCSSUpdatesRecord.d.ts", "releaseTag": "Public", "name": "CustomCSSUpdatesRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!CustomElementHandling:interface", "docComment": "/**\n * Configuration for custom element handling in DOMPurify.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomElementHandling " } ], "fileUrlPath": "src/dompurify/internals/CustomElementHandling.d.ts", "releaseTag": "Public", "name": "CustomElementHandling", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomElementHandling#allowCustomizedBuiltInElements:member", "docComment": "/**\n * Whether to allow customized built-in elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowCustomizedBuiltInElements?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "allowCustomizedBuiltInElements", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomElementHandling#attributeNameCheck:member", "docComment": "/**\n * Check function or regex for allowed attribute names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attributeNameCheck?: " }, { "kind": "Content", "text": "((attributeName: string) => boolean) | null | " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "attributeNameCheck", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!CustomElementHandling#tagNameCheck:member", "docComment": "/**\n * Check function or regex for allowed tag names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tagNameCheck?: " }, { "kind": "Content", "text": "((tagName: string) => boolean) | null | " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tagNameCheck", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DailyNotesOptions:interface", "docComment": "/**\n * Configuration options for the daily notes plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DailyNotesOptions " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/daily-notes/DailyNotesOptions.d.ts", "releaseTag": "Public", "name": "DailyNotesOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DailyNotesOptions#autorun:member", "docComment": "/**\n * Open the daily note automatically whenever the vault is opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autorun?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autorun", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DailyNotesOptions#folder:member", "docComment": "/**\n * New daily notes will be placed here.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "folder?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "folder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DailyNotesOptions#format:member", "docComment": "/**\n * Naming syntax for daily note in Moment.js syntax.\n *\n * @see\n *\n * {@link https://momentjs.com/docs/#/displaying/format/}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "format?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "format", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DailyNotesOptions#template:member", "docComment": "/**\n * Path to the file to use as a template.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "template?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "template", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DailyNotesPlugin:interface", "docComment": "/**\n * Internal plugin registration for the daily notes feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DailyNotesPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DailyNotesPluginInstance", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/daily-notes/DailyNotesPlugin.d.ts", "releaseTag": "Public", "name": "DailyNotesPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance:interface", "docComment": "/**\n * Plugin instance for daily notes, providing date-based note creation and navigation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DailyNotesPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DailyNotesPlugin", "canonicalReference": "obsidian-typings!DailyNotesPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/daily-notes/DailyNotesPluginInstance.d.ts", "releaseTag": "Public", "name": "DailyNotesPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#getCurrentFileDateTimestamp:member(1)", "docComment": "/**\n * Get the date timestamp from the currently open file name, or `null` if not a daily note.\n *\n * @returns The date timestamp, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCurrentFileDateTimestamp(): " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCurrentFileDateTimestamp" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#getDailyNote:member(1)", "docComment": "/**\n * Get or create the daily note for the given date.\n *\n * @param date - The moment date to get the daily note for.\n *\n * @returns The daily note file, or `null`/`undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDailyNote(date: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "momentInstance", "canonicalReference": "obsidian!moment:var" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": " | undefined>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "date", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "getDailyNote" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#getFormat:member(1)", "docComment": "/**\n * Get the configured date format string for daily note filenames.\n *\n * @returns The date format string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFormat(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFormat" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#gotoNextExisting:member(1)", "docComment": "/**\n * Navigate to the next existing daily note after the given timestamp.\n *\n * @param timestamp - The reference timestamp.\n *\n * @returns A promise that resolves when navigation is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gotoNextExisting(timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "timestamp", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "gotoNextExisting" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#gotoPreviousExisting:member(1)", "docComment": "/**\n * Navigate to the previous existing daily note before the given timestamp.\n *\n * @param timestamp - The reference timestamp.\n *\n * @returns A promise that resolves when navigation is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gotoPreviousExisting(timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "timestamp", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "gotoPreviousExisting" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#iterateDailyNotes:member(1)", "docComment": "/**\n * Iterate over all daily notes in the vault, invoking the callback for each.\n *\n * @param callback - The callback to invoke for each daily note.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iterateDailyNotes(callback: " }, { "kind": "Content", "text": "(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", timestamp: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "iterateDailyNotes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Handle external settings file changes and reload configuration.\n *\n * @returns A promise that resolves when the settings are reloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#onOpenDailyNote:member(1)", "docComment": "/**\n * Handle the open daily note command event.\n *\n * @param evt - The triggering event.\n *\n * @returns A promise that resolves when the daily note is opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onOpenDailyNote(evt: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onOpenDailyNote" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#options:member", "docComment": "/**\n * Configuration options for daily notes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "DailyNotesOptions", "canonicalReference": "obsidian-typings!DailyNotesOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance#plugin:member", "docComment": "/**\n * Reference to the daily notes plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "DailyNotesPlugin", "canonicalReference": "obsidian-typings!DailyNotesPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DataAdapterEx:interface", "docComment": "/**\n * Common members for {@link obsidian#CapacitorAdapter} and {@link obsidian#FileSystemAdapter}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DataAdapterEx extends " }, { "kind": "Reference", "text": "DataAdapter", "canonicalReference": "obsidian!DataAdapter:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PromisedQueue", "canonicalReference": "obsidian-typings!PromisedQueue:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/DataAdapterEx.d.ts", "releaseTag": "Public", "name": "DataAdapterEx", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#_exists:member(1)", "docComment": "/**\n * Check if a file exists.\n *\n * @param fullPath - full path to the file.\n *\n * @param sensitive - whether to check case-sensitive.\n *\n * @returns A promise that resolves to `true` if the file exists, `false` otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_exists(fullPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", sensitive?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<boolean>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fullPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "sensitive", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "_exists" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DataAdapterEx#basePath:member", "docComment": "/**\n * Base OS path for the vault (e.g. `/home/user/vault`, or `C:\\Users\\user\\documents\\vault`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "basePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "basePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DataAdapterEx#files:member", "docComment": "/**\n * Mapping of file/folder path to vault entry, includes non-MD files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "files: " }, { "kind": "Reference", "text": "DataAdapterFilesRecord", "canonicalReference": "obsidian-typings!DataAdapterFilesRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "files", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#getFullPath:member(1)", "docComment": "/**\n * Get canonical full path of file.\n *\n * @param path - path to file.\n *\n * @returns Full path to file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFullPath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFullPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#getFullRealPath:member(1)", "docComment": "/**\n * Get canonical full path of file.\n *\n * @param normalizedPath - normalized path to file.\n *\n * @returns String full path to file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFullRealPath(normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFullRealPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#getRealPath:member(1)", "docComment": "/**\n * Get normalized path.\n *\n * For vault-relative path, it's normalized vault-relative path. For absolute path, it's path as is.\n *\n * @param path - path to file.\n *\n * @returns Normalized path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRealPath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getRealPath" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DataAdapterEx#handler:member", "docComment": "/**\n * Handles vault events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handler: " }, { "kind": "Reference", "text": "FileSystemWatchHandler", "canonicalReference": "obsidian-typings!FileSystemWatchHandler:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "handler", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DataAdapterEx#insensitive:member", "docComment": "/**\n * Whether the file system is case-insensitive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insensitive: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "insensitive", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#listRecursive:member(1)", "docComment": "/**\n * Generates `this.files` for specific directory of the vault\n *\n * @param normalizedPath - The path to list recursively.\n *\n * @returns A promise that resolves when the recursive listing is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "listRecursive(normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "listRecursive" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#onFileChange:member(1)", "docComment": "/**\n * Handle a file change event for the given path.\n *\n * @param normalizedPath - The path that changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileChange(normalizedPath: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#reconcileDeletion:member(1)", "docComment": "/**\n * Reconcile a deletion.\n *\n * @param normalizedPath - path to file.\n *\n * @param normalizedNewPath - new path to file.\n *\n * @param shouldSkipDeletionTimeout - whether the deletion timeout should be skipped (default: `true`).\n *\n * @returns A promise that resolves when the file is reconciled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reconcileDeletion(\n normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n normalizedNewPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n shouldSkipDeletionTimeout?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "normalizedNewPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "shouldSkipDeletionTimeout", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "reconcileDeletion" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#reconcileFile:member(1)", "docComment": "/**\n * Reconcile a file.\n *\n * @param normalizedPath - normalized path to file.\n *\n * @param normalizedNewPath - normalized new path to file.\n *\n * @param shouldSkipDeletionTimeout - whether the deletion timeout should be skipped - applies only to {@link DataAdapterEx.reconcileDeletion}.\n *\n * @returns A promise that resolves when the file is reconciled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reconcileFile(\n normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n normalizedNewPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n shouldSkipDeletionTimeout?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "normalizedNewPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "shouldSkipDeletionTimeout", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "reconcileFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#reconcileFolderCreation:member(1)", "docComment": "/**\n * Reconcile a folder creation between old and new paths.\n *\n * @param normalizedPath - normalized original path.\n *\n * @param normalizedNewPath - normalized new path.\n *\n * @returns A promise that resolves when the folder creation is reconciled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reconcileFolderCreation(normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", normalizedNewPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "normalizedNewPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "reconcileFolderCreation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#reconcileInternalFile:member(1)", "docComment": "/**\n * Reconcile changes to an internal (config) file.\n *\n * @param normalizedPath - normalized path to the internal file.\n *\n * @returns A promise that resolves when the internal file is reconciled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reconcileInternalFile(normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "reconcileInternalFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#reconcileSymbolicLinkCreation:member(1)", "docComment": "/**\n * Reconcile a symbolic link creation between old and new paths.\n *\n * @param normalizedPath - The original path.\n *\n * @param normalizedNewPath - normalized new path.\n *\n * @returns A promise that resolves when the symbolic link creation is reconciled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reconcileSymbolicLinkCreation(normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", normalizedNewPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "normalizedNewPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "reconcileSymbolicLinkCreation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#removeFile:member(1)", "docComment": "/**\n * Remove file from files listing and trigger deletion event.\n *\n * @param normalizedPath - normalized path of the file to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeFile(normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#stopWatch:member(1)", "docComment": "/**\n * Remove all listeners.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopWatch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopWatch" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DataAdapterEx#trigger:member", "docComment": "/**\n * Triggers handler for vault events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trigger: " }, { "kind": "Reference", "text": "FileSystemWatchHandler", "canonicalReference": "obsidian-typings!FileSystemWatchHandler:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "trigger", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#update:member(1)", "docComment": "/**\n * Set whether OS is insensitive to case.\n *\n * @param normalizedPath - normalized path to update.\n *\n * @returns A promise that resolves when the update is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(normalizedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "normalizedPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DataAdapterEx#watch:member(1)", "docComment": "/**\n * Add change watcher to path.\n *\n * @param handler - handler for file system changes.\n *\n * @returns A promise that resolves when the watcher is registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "watch(handler: " }, { "kind": "Reference", "text": "FileSystemWatchHandler", "canonicalReference": "obsidian-typings!FileSystemWatchHandler:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "watch" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DataAdapterFilesRecord:interface", "docComment": "/**\n * Record mapping file paths to their file entry metadata in the data adapter.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DataAdapterFilesRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "FileEntry", "canonicalReference": "obsidian-typings!FileEntry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/data-adapter-records/DataAdapterFilesRecord.d.ts", "releaseTag": "Public", "name": "DataAdapterFilesRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DataAdapterWatchersRecord:interface", "docComment": "/**\n * A mapping between a vault-relative folder paths to the corresponding watcher entries.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DataAdapterWatchersRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "DataAdapterWatchersRecordEntry", "canonicalReference": "obsidian-typings!DataAdapterWatchersRecordEntry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/data-adapter-records/DataAdapterWatchersRecord.d.ts", "releaseTag": "Public", "name": "DataAdapterWatchersRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DataAdapterWatchersRecordEntry:interface", "docComment": "/**\n * Entry for a file system watcher registered by the data adapter.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DataAdapterWatchersRecordEntry " } ], "fileUrlPath": "src/obsidian/internals/data-adapter-records/DataAdapterWatchersRecordEntry.d.ts", "releaseTag": "Public", "name": "DataAdapterWatchersRecordEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DataAdapterWatchersRecordEntry#resolvedPath:member", "docComment": "/**\n * Resolved full path to the folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolvedPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resolvedPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DataAdapterWatchersRecordEntry#watcher:member", "docComment": "/**\n * Node.js file system watcher.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "watcher: " }, { "kind": "Reference", "text": "FSWatcher", "canonicalReference": "!\"\\\"node:fs\\\"\".FSWatcher:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "watcher", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Database:interface", "docComment": "/**\n * Represents a WebSQL database instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Database " } ], "fileUrlPath": "src/web-sql/internals/Database.d.ts", "releaseTag": "Public", "name": "Database", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Database#changeVersion:member(1)", "docComment": "/**\n * Change the database version, optionally running a migration transaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeVersion(\n oldVersion: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n newVersion: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n callback?: " }, { "kind": "Content", "text": "(transaction: " }, { "kind": "Reference", "text": "SQLTransaction", "canonicalReference": "obsidian-typings!SQLTransaction:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ",\n errorCallback?: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "SQLError", "canonicalReference": "obsidian-typings!SQLError:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ",\n successCallback?: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "oldVersion", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newVersion", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": true }, { "parameterName": "errorCallback", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 12 }, "isOptional": true }, { "parameterName": "successCallback", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "isOptional": true } ], "name": "changeVersion" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Database#readTransaction:member(1)", "docComment": "/**\n * Execute a read-only transaction against the database.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readTransaction(\n callback: " }, { "kind": "Content", "text": "(transaction: " }, { "kind": "Reference", "text": "SQLTransaction", "canonicalReference": "obsidian-typings!SQLTransaction:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ",\n errorCallback?: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "SQLError", "canonicalReference": "obsidian-typings!SQLError:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ",\n successCallback?: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false }, { "parameterName": "errorCallback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": true }, { "parameterName": "successCallback", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "name": "readTransaction" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Database#transaction:member(1)", "docComment": "/**\n * Execute a read-write transaction against the database.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transaction(\n callback: " }, { "kind": "Content", "text": "(transaction: " }, { "kind": "Reference", "text": "SQLTransaction", "canonicalReference": "obsidian-typings!SQLTransaction:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ",\n errorCallback?: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "SQLError", "canonicalReference": "obsidian-typings!SQLError:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ",\n successCallback?: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false }, { "parameterName": "errorCallback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": true }, { "parameterName": "successCallback", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "name": "transaction" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Database#version:member", "docComment": "/**\n * Current version string of the database schema.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DateAfterFunction:interface", "docComment": "/**\n * Function `DateAfter`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DateAfterFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DateAfterFunction.d.ts", "releaseTag": "Public", "name": "DateAfterFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DateBeforeFunction:interface", "docComment": "/**\n * Function `DateBefore`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DateBeforeFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DateBeforeFunction.d.ts", "releaseTag": "Public", "name": "DateBeforeFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DateDiffFunction:interface", "docComment": "/**\n * Function `DateDiff`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DateDiffFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DateDiffFunction.d.ts", "releaseTag": "Public", "name": "DateDiffFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DateEqualsFunction:interface", "docComment": "/**\n * Function `DateEquals`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DateEqualsFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DateEqualsFunction.d.ts", "releaseTag": "Public", "name": "DateEqualsFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DateModifyFunction:interface", "docComment": "/**\n * Function `DateModify`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DateModifyFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DateModifyFunction.d.ts", "releaseTag": "Public", "name": "DateModifyFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DateNotEqualsFunction:interface", "docComment": "/**\n * Function `DateNotEquals`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DateNotEqualsFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DateNotEqualsFunction.d.ts", "releaseTag": "Public", "name": "DateNotEqualsFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DateOnOrAfterFunction:interface", "docComment": "/**\n * Function `DateOnOrAfter`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DateOnOrAfterFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DateOnOrAfterFunction.d.ts", "releaseTag": "Public", "name": "DateOnOrAfterFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DateOnOrBeforeFunction:interface", "docComment": "/**\n * Function `DateOnOrBefore`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DateOnOrBeforeFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DateOnOrBeforeFunction.d.ts", "releaseTag": "Public", "name": "DateOnOrBeforeFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for dates.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DatePropertyWidgetComponent extends " }, { "kind": "Reference", "text": "DatePropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/DatePropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "DatePropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponent#buttonEl:member", "docComment": "/**\n * The button element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttonEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "buttonEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'date'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase:interface", "docComment": "/**\n * Base interface for date property widget components.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DatePropertyWidgetComponentBase extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/DatePropertyWidgetComponentBase.d.ts", "releaseTag": "Public", "name": "DatePropertyWidgetComponentBase", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase#buildInput:member(1)", "docComment": "/**\n * Build the input element for the property widget.\n *\n * @param parentEl - The parent element.\n *\n * @returns The input element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buildInput(parentEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "parentEl", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "buildInput" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase#date:member", "docComment": "/**\n * The date of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "date?: " }, { "kind": "Reference", "text": "moment.Moment", "canonicalReference": "moment!moment.Moment:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "date", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase#dirty:member", "docComment": "/**\n * Whether the property widget is dirty.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dirty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dirty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase#format:member(1)", "docComment": "/**\n * Format the date input.\n *\n * @param input - The input to format.\n *\n * @returns The formatted date.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "format(input: " }, { "kind": "Reference", "text": "moment.Moment", "canonicalReference": "moment!moment.Moment:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "format" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase#hoverPopup:member", "docComment": "/**\n * The hover popup for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverPopup: " }, { "kind": "Reference", "text": "HoverPopover", "canonicalReference": "obsidian!HoverPopover:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverPopup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase#inputEl:member", "docComment": "/**\n * The input element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase#parse:member(1)", "docComment": "/**\n * Parse the date input.\n *\n * @param input - The input to parse.\n *\n * @returns The parsed date.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parse(input: " }, { "kind": "Reference", "text": "moment.MomentInput", "canonicalReference": "moment!moment.MomentInput:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "parse" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase#value:member", "docComment": "/**\n * The value of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DatetimePropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for datetimes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DatetimePropertyWidgetComponent extends " }, { "kind": "Reference", "text": "DatePropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/DatetimePropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "DatetimePropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DatetimePropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'datetime'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DayFunction:interface", "docComment": "/**\n * Function `Day`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DayFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasExtract", "canonicalReference": "obsidian-typings!HasExtract:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/DayFunction.d.ts", "releaseTag": "Public", "name": "DayFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DecorationAttributes:interface", "docComment": "/**\n * A record of HTML attribute names to values.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DecorationAttributes " } ], "fileUrlPath": "src/@codemirror__view/internals/DecorationAttributes.d.ts", "releaseTag": "Public", "name": "DecorationAttributes", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!DecorationAttributes:index(1)", "docComment": "/**\n * An HTML attribute value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!defaults:var", "docComment": "/**\n * Default configuration options for CodeMirror 5 editors.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaults: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" } ], "fileUrlPath": "src/codemirror/internals/vars/defaults.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "defaults", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DeferredView:interface", "docComment": "/**\n * A lazily loaded view placeholder that defers initialization until the view is actually needed.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DeferredView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/DeferredView.d.ts", "releaseTag": "Public", "name": "DeferredView", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Function", "canonicalReference": "obsidian-typings!defineExtension:function(1)", "docComment": "/**\n * Registers a new editor extension method.\n *\n * @param name - The extension name.\n *\n * @param value - The extension implementation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function defineExtension(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/defineExtension.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "defineExtension" }, { "kind": "Function", "canonicalReference": "obsidian-typings!defineInitHook:function(1)", "docComment": "/**\n * Registers a function to be called when an editor is initialized.\n *\n * @param f - The initialization hook function.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function defineInitHook(f: " }, { "kind": "Content", "text": "(cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/defineInitHook.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "defineInitHook" }, { "kind": "Function", "canonicalReference": "obsidian-typings!defineMode:function(1)", "docComment": "/**\n * Registers a new editor mode.\n *\n * @param name - The mode name.\n *\n * @param modeFactory - The factory function that creates the mode.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function defineMode<T>(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", modeFactory: " }, { "kind": "Reference", "text": "Cm5ModeFactory", "canonicalReference": "obsidian-typings!Cm5ModeFactory:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/defineMode.d.ts", "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "modeFactory", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "defineMode" }, { "kind": "Function", "canonicalReference": "obsidian-typings!defineOption:function(1)", "docComment": "/**\n * Registers a new editor option.\n *\n * @param name - The option name.\n *\n * @param defaultValue - The default value for the option.\n *\n * @param onUpdate - The update handler called when the option changes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function defineOption(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", defaultValue: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", onUpdate: " }, { "kind": "Content", "text": "(editor: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ", val: unknown, old: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/defineOption.d.ts", "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "defaultValue", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "onUpdate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": false } ], "name": "defineOption" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DiagramDefinition:interface", "docComment": "/**\n * Definition of a Mermaid diagram type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DiagramDefinition " } ], "fileUrlPath": "src/mermaid/internals/DiagramDefinition.d.ts", "releaseTag": "Public", "name": "DiagramDefinition", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DiagramDefinition#db:member", "docComment": "/**\n * Database/data store for the diagram.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "db: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "db", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DiagramDefinition#parser:member", "docComment": "/**\n * Parser for the diagram syntax.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parser: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parser", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DiagramDefinition#renderer:member", "docComment": "/**\n * Renderer for the diagram.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderer: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DiagramDefinition#styles:member", "docComment": "/**\n * Styles for the diagram.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "styles?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "styles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DiagramDefinitionModule:interface", "docComment": "/**\n * Module containing a diagram definition.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DiagramDefinitionModule " } ], "fileUrlPath": "src/mermaid/internals/DiagramDefinitionModule.d.ts", "releaseTag": "Public", "name": "DiagramDefinitionModule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DiagramDefinitionModule#diagram:member", "docComment": "/**\n * The diagram definition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "diagram: " }, { "kind": "Reference", "text": "DiagramDefinition", "canonicalReference": "obsidian-typings!DiagramDefinition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "diagram", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!dialog:var", "docComment": "/**\n * Electron dialog instance for showing native system dialogs.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dialog: " }, { "kind": "Reference", "text": "ElectronDialog", "canonicalReference": "obsidian-typings!ElectronDialog:interface" } ], "fileUrlPath": "src/electron/internals/vars/dialog.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "dialog", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Dimensions:interface", "docComment": "/**\n * Width and height dimensions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Dimensions " } ], "fileUrlPath": "src/obsidian/internals/Dimensions.d.ts", "releaseTag": "Public", "name": "Dimensions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Dimensions#height:member", "docComment": "/**\n * The height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Dimensions#width:member", "docComment": "/**\n * The width.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!dir:var", "docComment": "/**\n * Returns the text direction for a language.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dir: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['dir']" } ], "fileUrlPath": "src/i18next/internals/functions/dir.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "dir", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Variable", "canonicalReference": "obsidian-typings!disableWorkerMessageHandler:var", "docComment": "/**\n * Whether to disable the default Prism worker message handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableWorkerMessageHandler: " }, { "kind": "Content", "text": "boolean | undefined" } ], "fileUrlPath": "src/prismjs/internals/vars/disableWorkerMessageHandler.d.ts", "isReadonly": false, "releaseTag": "Public", "name": "disableWorkerMessageHandler", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Class", "canonicalReference": "obsidian-typings!DisplayObject:class", "docComment": "/**\n * Base class for all display objects.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class DisplayObject " } ], "fileUrlPath": "src/pixi.js/internals/DisplayObject.d.ts", "releaseTag": "Public", "isAbstract": true, "name": "DisplayObject", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#alpha:member", "docComment": "/**\n * Alpha (opacity).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "alpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#angle:member", "docComment": "/**\n * Rotation angle in degrees.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "angle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "angle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#cursor:member", "docComment": "/**\n * Cursor style when hovering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursor: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cursor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#destroy:member(1)", "docComment": "/**\n * Destroys this display object.\n *\n * @param options - Destroy options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(options?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "IDestroyOptions", "canonicalReference": "obsidian-typings!IDestroyOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#emit:member(1)", "docComment": "/**\n * Emits an event.\n *\n * @param event - Event name.\n *\n * @param args - Arguments.\n *\n * @returns Whether any listeners were called.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "emit(event: " }, { "kind": "Content", "text": "string | symbol" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "emit" }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#getBounds:member(1)", "docComment": "/**\n * Returns the bounds of the object.\n *\n * @param skipUpdate - Whether to skip the update.\n *\n * @param rect - Rectangle to store bounds in.\n *\n * @returns The bounds rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBounds(skipUpdate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", rect?: " }, { "kind": "Reference", "text": "PixiRectangle", "canonicalReference": "obsidian-typings!PixiRectangle:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PixiRectangle", "canonicalReference": "obsidian-typings!PixiRectangle:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "skipUpdate", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "getBounds" }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#getLocalBounds:member(1)", "docComment": "/**\n * Returns the local bounds of the object.\n *\n * @param rect - Rectangle to store bounds in.\n *\n * @returns The local bounds rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLocalBounds(rect?: " }, { "kind": "Reference", "text": "PixiRectangle", "canonicalReference": "obsidian-typings!PixiRectangle:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PixiRectangle", "canonicalReference": "obsidian-typings!PixiRectangle:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "getLocalBounds" }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#hitArea:member", "docComment": "/**\n * Hit area shape.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hitArea: " }, { "kind": "Reference", "text": "IHitArea", "canonicalReference": "obsidian-typings!IHitArea:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hitArea", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#interactive:member", "docComment": "/**\n * Whether the object is interactive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interactive: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "interactive", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#name:member", "docComment": "/**\n * Display name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#off:member(1)", "docComment": "/**\n * Removes an event listener.\n *\n * @param event - Event name.\n *\n * @param fn - Callback function.\n *\n * @param context - Callback context.\n *\n * @returns This object for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(event: " }, { "kind": "Content", "text": "string | symbol" }, { "kind": "Content", "text": ", fn?: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": ", context?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "off" }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#on:member(1)", "docComment": "/**\n * Adds an event listener.\n *\n * @param event - Event name.\n *\n * @param fn - Callback function.\n *\n * @param context - Callback context.\n *\n * @returns This object for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "string | symbol" }, { "kind": "Content", "text": ", fn: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": ", context?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#once:member(1)", "docComment": "/**\n * Adds a one-time event listener.\n *\n * @param event - Event name.\n *\n * @param fn - Callback function.\n *\n * @param context - Callback context.\n *\n * @returns This object for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "string | symbol" }, { "kind": "Content", "text": ", fn: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": ", context?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#parent:member", "docComment": "/**\n * Parent container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent: " }, { "kind": "Reference", "text": "Container", "canonicalReference": "obsidian-typings!Container:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#pivot:member", "docComment": "/**\n * Pivot point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get pivot(): " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";\n\nset pivot(value: " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pivot", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#position:member", "docComment": "/**\n * Position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get position(): " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";\n\nset position(value: " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#removeAllListeners:member(1)", "docComment": "/**\n * Removes all listeners for the given event.\n *\n * @param event - Event name.\n *\n * @returns This object for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeAllListeners(event?: " }, { "kind": "Content", "text": "string | symbol" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "removeAllListeners" }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#renderable:member", "docComment": "/**\n * Whether the object is renderable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#rotation:member", "docComment": "/**\n * Rotation in radians.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rotation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#scale:member", "docComment": "/**\n * Scale.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get scale(): " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";\n\nset scale(value: " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#skew:member", "docComment": "/**\n * Skew.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get skew(): " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";\n\nset skew(value: " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "skew", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#toGlobal:member(1)", "docComment": "/**\n * Converts a point to global (screen) coordinates.\n *\n * @param position - The point to convert.\n *\n * @param point - Output point.\n *\n * @param skipUpdate - Whether to skip the update.\n *\n * @returns The global point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toGlobal<P extends " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ">(position: " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ", point?: " }, { "kind": "Content", "text": "P" }, { "kind": "Content", "text": ", skipUpdate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "P" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "position", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "point", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "skipUpdate", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "toGlobal" }, { "kind": "Method", "canonicalReference": "obsidian-typings!DisplayObject#toLocal:member(1)", "docComment": "/**\n * Converts a point to local coordinates.\n *\n * @param position - The point to convert.\n *\n * @param from - The display object to convert from.\n *\n * @param point - Output point.\n *\n * @param skipUpdate - Whether to skip the update.\n *\n * @returns The local point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toLocal<P extends " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ">(position: " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ", from?: " }, { "kind": "Reference", "text": "DisplayObject", "canonicalReference": "obsidian-typings!DisplayObject:class" }, { "kind": "Content", "text": ", point?: " }, { "kind": "Content", "text": "P" }, { "kind": "Content", "text": ", skipUpdate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "P" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "position", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "point", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true }, { "parameterName": "skipUpdate", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "toLocal" }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#transform:member", "docComment": "/**\n * Transform data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transform: " }, { "kind": "Reference", "text": "Transform", "canonicalReference": "obsidian-typings!Transform:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "transform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#visible:member", "docComment": "/**\n * Whether the object is visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "visible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "visible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#worldAlpha:member", "docComment": "/**\n * Alpha relative to the scene.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "worldAlpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "worldAlpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#worldTransform:member", "docComment": "/**\n * World transform matrix (read-only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly worldTransform: " }, { "kind": "Reference", "text": "Matrix", "canonicalReference": "obsidian-typings!Matrix:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "worldTransform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#worldVisible:member", "docComment": "/**\n * Whether the object is visible in the scene (read-only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly worldVisible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "worldVisible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#x:member", "docComment": "/**\n * X position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#y:member", "docComment": "/**\n * Y position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!DisplayObject#zIndex:member", "docComment": "/**\n * Z-index for sorting.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Doc:interface", "docComment": "/**\n * A CodeMirror 5 document instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Doc " } ], "fileUrlPath": "src/codemirror/internals/Doc.d.ts", "releaseTag": "Public", "name": "Doc", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#addLineWidget:member(1)", "docComment": "/**\n * Adds a line widget below the given line.\n *\n * @param line - The line number or handle.\n *\n * @param node - The DOM node to display.\n *\n * @param options - Optional widget configuration.\n *\n * @returns The created line widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addLineWidget(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ", node: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5LineWidgetOptions", "canonicalReference": "obsidian-typings!Cm5LineWidgetOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5LineWidget", "canonicalReference": "obsidian-typings!Cm5LineWidget:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "addLineWidget" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#addSelection:member(1)", "docComment": "/**\n * Adds a new selection to the existing set of selections.\n *\n * @param anchor - The anchor position.\n *\n * @param head - The optional head position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSelection(anchor: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", head?: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "anchor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "head", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "addSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#changeGeneration:member(1)", "docComment": "/**\n * Returns a number that can later be passed to isClean to test whether any edits were made.\n *\n * @param closeEvent - Whether to close the current history event.\n *\n * @returns The generation number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeGeneration(closeEvent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "closeEvent", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "changeGeneration" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#clearHistory:member(1)", "docComment": "/**\n * Clears the editor's undo history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearHistory(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearHistory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#copy:member(1)", "docComment": "/**\n * Create an identical copy of this document.\n *\n * @param copyHistory - Whether to copy the history.\n *\n * @returns The new document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copy(copyHistory: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "copyHistory", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "copy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#eachLine:member(1)", "docComment": "/**\n * Iterate over the whole document, calling f for each line.\n *\n * @param f - The function to call for each line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eachLine(f: " }, { "kind": "Content", "text": "(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "eachLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#eachLine:member(2)", "docComment": "/**\n * Iterate over a range of lines.\n *\n * @param start - The start line number.\n *\n * @param end - The end line number (exclusive).\n *\n * @param f - The function to call for each line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eachLine(start: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", end: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", f: " }, { "kind": "Content", "text": "(line: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "start", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "end", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": false } ], "name": "eachLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#extendSelection:member(1)", "docComment": "/**\n * Moves the head of the selection while leaving the anchor in place.\n *\n * @param from - The position to extend from.\n *\n * @param to - Optional end of region to select.\n *\n * @param options - Optional selection options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extendSelection(from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", to?: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5SelectionOptions", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "extendSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#extendSelections:member(1)", "docComment": "/**\n * Like extendSelection, but acts on all selections at once.\n *\n * @param heads - The new head positions.\n *\n * @param options - Optional selection options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extendSelections(heads: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5SelectionOptions", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "heads", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ], "name": "extendSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#extendSelectionsBy:member(1)", "docComment": "/**\n * Applies a function to all selections and calls extendSelections on the result.\n *\n * @param f - The function to apply to each range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extendSelectionsBy(f: " }, { "kind": "Content", "text": "(range: " }, { "kind": "Reference", "text": "Cm5Range", "canonicalReference": "obsidian-typings!Cm5Range:interface" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "name": "extendSelectionsBy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#findMarks:member(1)", "docComment": "/**\n * Returns an array of all the bookmarks and marked ranges found between the given positions.\n *\n * @param from - The start position.\n *\n * @param to - The end position.\n *\n * @returns An array of text markers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findMarks(from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", to: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TextMarker", "canonicalReference": "obsidian-typings!TextMarker:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "findMarks" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#findMarksAt:member(1)", "docComment": "/**\n * Returns an array of all the bookmarks and marked ranges at the given position.\n *\n * @param pos - The position.\n *\n * @returns An array of text markers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findMarksAt(pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TextMarker", "canonicalReference": "obsidian-typings!TextMarker:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "findMarksAt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#firstLine:member(1)", "docComment": "/**\n * Get the first line of the editor.\n *\n * @returns The number of the first line (usually `0`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "firstLine(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "firstLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getAllMarks:member(1)", "docComment": "/**\n * Returns an array containing all marked ranges in the document.\n *\n * @returns An array of text markers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAllMarks(): " }, { "kind": "Reference", "text": "TextMarker", "canonicalReference": "obsidian-typings!TextMarker:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAllMarks" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getCursor:member(1)", "docComment": "/**\n * Gets the cursor position.\n *\n * @param start - Optional string indicating which end of the selection to return.\n *\n * @returns The cursor position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCursor(start?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "start", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getCursor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getEditor:member(1)", "docComment": "/**\n * Retrieve the editor associated with this document.\n *\n * @returns The editor, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEditor(): " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getEditor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getExtending:member(1)", "docComment": "/**\n * Get the value of the 'extending' flag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getExtending(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getExtending" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getHistory:member(1)", "docComment": "/**\n * Get a JSON-serializable representation of the undo history.\n *\n * @returns The history object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHistory(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getHistory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getLine:member(1)", "docComment": "/**\n * Gets the content of the given line.\n *\n * @param n - The line number.\n *\n * @returns The content of the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLine(n: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getLineHandle:member(1)", "docComment": "/**\n * Fetches the line handle for the given line number.\n *\n * @param num - The line number.\n *\n * @returns The line handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLineHandle(num: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "num", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getLineHandle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getLineNumber:member(1)", "docComment": "/**\n * Given a line handle, returns the current position of that line.\n *\n * @param handle - The line handle.\n *\n * @returns The line number, or `null` if no longer in the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLineNumber(handle: " }, { "kind": "Reference", "text": "Cm5LineHandle", "canonicalReference": "obsidian-typings!Cm5LineHandle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "handle", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getLineNumber" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getMode:member(1)", "docComment": "/**\n * Gets the mode object for this document.\n *\n * @returns The mode object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMode(): " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getRange:member(1)", "docComment": "/**\n * Gets the text between the given points.\n *\n * @param from - The start position.\n *\n * @param to - The end position.\n *\n * @param separator - Optional line separator.\n *\n * @returns The text between the positions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRange(from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", to: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", separator?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "separator", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "getRange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getSelection:member(1)", "docComment": "/**\n * Gets the currently selected text.\n *\n * @param lineSep - Optional line separator.\n *\n * @returns The selected text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSelection(lineSep?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lineSep", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getSelections:member(1)", "docComment": "/**\n * Returns an array containing a string for each selection.\n *\n * @param lineSep - Optional line separator.\n *\n * @returns The selected texts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSelections(lineSep?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lineSep", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#getValue:member(1)", "docComment": "/**\n * Gets the editor content.\n *\n * @param separator - Optional line separator.\n *\n * @returns The editor content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getValue(separator?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "separator", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#historySize:member(1)", "docComment": "/**\n * Gets the number of undo/redo operations available.\n *\n * @returns An object with `undo` and `redo` counts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "historySize(): " }, { "kind": "Reference", "text": "DocHistorySize", "canonicalReference": "obsidian-typings!DocHistorySize:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "historySize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#indexFromPos:member(1)", "docComment": "/**\n * The reverse of posFromIndex.\n *\n * @param object - The position.\n *\n * @returns The zero-based index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indexFromPos(object: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "object", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "indexFromPos" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#isClean:member(1)", "docComment": "/**\n * Returns whether the document is currently clean.\n *\n * @param generation - Optional generation value from changeGeneration.\n *\n * @returns Whether the document is clean.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isClean(generation?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "generation", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "isClean" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#iterLinkedDocs:member(1)", "docComment": "/**\n * Will call the given function for all documents linked to this document.\n *\n * @param fn - The function to call for each linked document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iterLinkedDocs(fn: " }, { "kind": "Content", "text": "(doc: " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": ", sharedHist: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "iterLinkedDocs" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#lastLine:member(1)", "docComment": "/**\n * Get the last line of the editor.\n *\n * @returns The number of the last line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastLine(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "lastLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#lineCount:member(1)", "docComment": "/**\n * Gets the number of lines in the document.\n *\n * @returns The line count.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineCount(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "lineCount" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#lineSeparator:member(1)", "docComment": "/**\n * Returns the preferred line separator string for this document.\n *\n * @returns The line separator string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineSeparator(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "lineSeparator" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#linkedDoc:member(1)", "docComment": "/**\n * Create a new document linked to this one.\n *\n * @param options - Link options.\n *\n * @returns The linked document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linkedDoc(options: " }, { "kind": "Reference", "text": "Cm5LinkedDocOptions", "canonicalReference": "obsidian-typings!Cm5LinkedDocOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "linkedDoc" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#markClean:member(1)", "docComment": "/**\n * Set the editor content as 'clean'.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "markClean(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "markClean" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#markText:member(1)", "docComment": "/**\n * Marks a range of text with a specific CSS class.\n *\n * @param from - The start position.\n *\n * @param to - The end position.\n *\n * @param options - Optional marker options.\n *\n * @returns The created text marker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "markText(from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", to: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5TextMarkerOptions", "canonicalReference": "obsidian-typings!Cm5TextMarkerOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TextMarker", "canonicalReference": "obsidian-typings!TextMarker:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "markText" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Doc#modeOption:member", "docComment": "/**\n * The mode specification for this document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modeOption: " }, { "kind": "Reference", "text": "Cm5ModeSpec", "canonicalReference": "obsidian-typings!Cm5ModeSpec:type" }, { "kind": "Content", "text": "<unknown> | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modeOption", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#off:member(1)", "docComment": "/**\n * Removes an event listener.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(eventName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#on:member(1)", "docComment": "/**\n * Registers an event listener.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(eventName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#posFromIndex:member(1)", "docComment": "/**\n * Calculates a position for a zero-based index.\n *\n * @param index - The zero-based index.\n *\n * @returns The position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "posFromIndex(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "posFromIndex" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#redo:member(1)", "docComment": "/**\n * Redoes the last undone edit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redo(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "redo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#redoSelection:member(1)", "docComment": "/**\n * Redo one undone selection change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redoSelection(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "redoSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#removeLine:member(1)", "docComment": "/**\n * Remove the given line from the document.\n *\n * @param n - The line number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeLine(n: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#removeLineWidget:member(1)", "docComment": "/**\n * Removes a line widget.\n *\n * @param widget - The widget to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeLineWidget(widget: " }, { "kind": "Reference", "text": "Cm5LineWidget", "canonicalReference": "obsidian-typings!Cm5LineWidget:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "widget", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeLineWidget" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#replaceRange:member(1)", "docComment": "/**\n * Replaces the range between the given points with the given string.\n *\n * @param replacement - The replacement text.\n *\n * @param from - The start position.\n *\n * @param to - The optional end position.\n *\n * @param origin - Optional origin string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceRange(replacement: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", to?: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replacement", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "replaceRange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#replaceSelection:member(1)", "docComment": "/**\n * Replaces the current selection with the given string.\n *\n * @param replacement - The replacement text.\n *\n * @param select - Optional selection behavior after replacement.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceSelection(replacement: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", select?: " }, { "kind": "Content", "text": "'around' | 'start'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replacement", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "select", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "replaceSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#replaceSelections:member(1)", "docComment": "/**\n * Replaces the content of the selections.\n *\n * @param replacements - The replacement strings.\n *\n * @param collapse - How to collapse selections after replacement.\n *\n * @param origin - Optional origin string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceSelections(replacements: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", collapse?: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ", origin?: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replacements", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "collapse", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "replaceSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#setBookmark:member(1)", "docComment": "/**\n * Inserts a bookmark at the given position.\n *\n * @param pos - The position of the bookmark.\n *\n * @param options - Optional bookmark options.\n *\n * @returns The created text marker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBookmark(pos: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5BookmarkOptions", "canonicalReference": "obsidian-typings!Cm5BookmarkOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TextMarker", "canonicalReference": "obsidian-typings!TextMarker:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "setBookmark" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#setCursor:member(1)", "docComment": "/**\n * Sets the cursor position.\n *\n * @param pos - The position or line number.\n *\n * @param ch - Optional character position.\n *\n * @param options - Optional cursor options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCursor(pos: " }, { "kind": "Content", "text": "number | " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", ch?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5SelectionOptions", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "ch", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "setCursor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#setExtending:member(1)", "docComment": "/**\n * Sets or clears the 'extending' flag.\n *\n * @param value - Whether to enable extending.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setExtending(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setExtending" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#setHistory:member(1)", "docComment": "/**\n * Replace the editor's undo history.\n *\n * @param history - The history object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHistory(history: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "history", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setHistory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#setLine:member(1)", "docComment": "/**\n * Set the content of a given line.\n *\n * @param n - The line number.\n *\n * @param text - The new text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setLine(n: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setLine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#setSelection:member(1)", "docComment": "/**\n * Sets the selection range.\n *\n * @param anchor - The anchor position.\n *\n * @param head - The optional head position.\n *\n * @param options - Optional selection options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSelection(anchor: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", head?: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5SelectionOptions", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "anchor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "head", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "setSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#setSelections:member(1)", "docComment": "/**\n * Sets a new set of selections.\n *\n * @param ranges - The selection ranges.\n *\n * @param primary - The index of the primary selection.\n *\n * @param options - Optional selection options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSelections(ranges: " }, { "kind": "Reference", "text": "Cm5SelectionRange", "canonicalReference": "obsidian-typings!Cm5SelectionRange:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", primary?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5SelectionOptions", "canonicalReference": "obsidian-typings!Cm5SelectionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ranges", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "primary", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "setSelections" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#setValue:member(1)", "docComment": "/**\n * Sets the editor content.\n *\n * @param content - The new content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#somethingSelected:member(1)", "docComment": "/**\n * Tells whether the editor currently has a selection.\n *\n * @returns `true` if text is selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "somethingSelected(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "somethingSelected" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#undo:member(1)", "docComment": "/**\n * Undoes the last edit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undo(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "undo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#undoSelection:member(1)", "docComment": "/**\n * Undo one selection change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undoSelection(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "undoSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Doc#unlinkDoc:member(1)", "docComment": "/**\n * Break the link between two documents.\n *\n * @param doc - The document to unlink.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unlinkDoc(doc: " }, { "kind": "Reference", "text": "Doc", "canonicalReference": "obsidian-typings!Doc:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "doc", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unlinkDoc" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DocHistorySize:interface", "docComment": "/**\n * The number of undo and redo operations available.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DocHistorySize " } ], "fileUrlPath": "src/codemirror/internals/DocHistorySize.d.ts", "releaseTag": "Public", "name": "DocHistorySize", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocHistorySize#redo:member", "docComment": "/**\n * The number of redo operations available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redo: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "redo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocHistorySize#undo:member", "docComment": "/**\n * The number of undo operations available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undo: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "undo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DocumentInitParameters:interface", "docComment": "/**\n * Parameters for initializing a PDF document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DocumentInitParameters " } ], "fileUrlPath": "src/pdfjs-dist/internals/DocumentInitParameters.d.ts", "releaseTag": "Public", "name": "DocumentInitParameters", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#cMapPacked:member", "docComment": "/**\n * Whether CMap files are packed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cMapPacked?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cMapPacked", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#cMapUrl:member", "docComment": "/**\n * URL for CMap files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cMapUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cMapUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#data:member", "docComment": "/**\n * Document data as ArrayBuffer, string, or Uint8Array.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data?: " }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": " | string | " }, { "kind": "Reference", "text": "Uint8Array", "canonicalReference": "!Uint8Array:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#disableAutoFetch:member", "docComment": "/**\n * Whether to disable automatic data fetching.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableAutoFetch?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableAutoFetch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#disableFontFace:member", "docComment": "/**\n * Whether to disable font face creation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableFontFace?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableFontFace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#disableRange:member", "docComment": "/**\n * Whether to disable range requests.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableRange?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableRange", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#disableStream:member", "docComment": "/**\n * Whether to disable streaming.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableStream?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableStream", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#httpHeaders:member", "docComment": "/**\n * HTTP headers to include in requests.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "httpHeaders?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "httpHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#isEvalSupported:member", "docComment": "/**\n * Whether eval is supported in the environment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEvalSupported?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isEvalSupported", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#isOffscreenCanvasSupported:member", "docComment": "/**\n * Whether OffscreenCanvas is supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isOffscreenCanvasSupported?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isOffscreenCanvasSupported", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#password:member", "docComment": "/**\n * Password for encrypted documents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "password?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "password", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#standardFontDataUrl:member", "docComment": "/**\n * URL for standard font data files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "standardFontDataUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "standardFontDataUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#url:member", "docComment": "/**\n * Document URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#useSystemFonts:member", "docComment": "/**\n * Whether to use system fonts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useSystemFonts?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "useSystemFonts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#verbosity:member", "docComment": "/**\n * Verbosity level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "verbosity?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "verbosity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#withCredentials:member", "docComment": "/**\n * Whether to include credentials in requests.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "withCredentials?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "withCredentials", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DocumentInitParameters#worker:member", "docComment": "/**\n * PDF.js worker instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "worker?: " }, { "kind": "Reference", "text": "PDFWorker", "canonicalReference": "obsidian-typings!PDFWorker:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "worker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DomEventsHandlers:interface", "docComment": "/**\n * The handlers for the DOM events.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DomEventsHandlers " } ], "fileUrlPath": "src/obsidian/internals/DomEventsHandlers.d.ts", "releaseTag": "Public", "name": "DomEventsHandlers", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DomEventsHandlers#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use `getDomEventsHandlersConstructor` from `obsidian-dev-utils/obsidian/constructors/getDomEventsHandlersConstructor`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param info - The info.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(info: " }, { "kind": "Reference", "text": "DomEventsHandlersInfo", "canonicalReference": "obsidian-typings!DomEventsHandlersInfo:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DomEventsHandlers#onExternalLinkClick:member(1)", "docComment": "/**\n * Handles the external link click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n *\n * @returns The result of handling the click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalLinkClick(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "linkText", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onExternalLinkClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DomEventsHandlers#onExternalLinkRightClick:member(1)", "docComment": "/**\n * Handles the external link right click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n *\n * @returns The result of handling the right click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalLinkRightClick(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "linkText", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onExternalLinkRightClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DomEventsHandlers#onInternalLinkClick:member(1)", "docComment": "/**\n * Handles the internal link click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n *\n * @returns The result of handling the click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInternalLinkClick(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "linkText", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onInternalLinkClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DomEventsHandlers#onInternalLinkDrag:member(1)", "docComment": "/**\n * Handles the internal link drag event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n *\n * @param title - The title.\n *\n * @returns The result of handling the drag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInternalLinkDrag(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "linkText", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "onInternalLinkDrag" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DomEventsHandlers#onInternalLinkMouseover:member(1)", "docComment": "/**\n * Handles the internal link mouseover event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n *\n * @returns The result of handling the mouseover.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInternalLinkMouseover(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "linkText", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onInternalLinkMouseover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DomEventsHandlers#onInternalLinkRightClick:member(1)", "docComment": "/**\n * Handles the internal link right click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n *\n * @returns The result of handling the right click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInternalLinkRightClick(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "linkText", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onInternalLinkRightClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DomEventsHandlers#onTagClick:member(1)", "docComment": "/**\n * Handles the tag click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param tag - The tag text.\n *\n * @returns The result of handling the tag click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTagClick(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", tag: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "tag", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onTagClick" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DomEventsHandlersInfo:interface", "docComment": "/**\n * Information about the DOM events handlers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DomEventsHandlersInfo extends " }, { "kind": "Reference", "text": "HoverParent", "canonicalReference": "obsidian!HoverParent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/DomEventsHandlersInfo.d.ts", "releaseTag": "Public", "name": "DomEventsHandlersInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DomEventsHandlersInfo#app:member", "docComment": "/**\n * Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DomEventsHandlersInfo#path:member", "docComment": "/**\n * The path to calculate relative links from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!DOMPurify:type", "docComment": "/**\n * DOMPurify library type, callable to create a new instance scoped to a window.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type DOMPurify = " }, { "kind": "Content", "text": "{\n (window?: " }, { "kind": "Reference", "text": "Window", "canonicalReference": "!Window:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "DOMPurifyI", "canonicalReference": "obsidian-typings!DOMPurifyI:interface" }, { "kind": "Content", "text": ";\n} & " }, { "kind": "Reference", "text": "DOMPurifyI", "canonicalReference": "obsidian-typings!DOMPurifyI:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/dompurify/internals/DOMPurify.d.ts", "releaseTag": "Public", "name": "DOMPurify", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DOMPurifyI:interface", "docComment": "/**\n * DOMPurify instance interface providing HTML sanitization methods.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DOMPurifyI " } ], "fileUrlPath": "src/dompurify/internals/DOMPurifyI.d.ts", "releaseTag": "Public", "name": "DOMPurifyI", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#addHook:member(1)", "docComment": "/**\n * Add a hook to DOMPurify.\n *\n * @param hook - The hook name.\n *\n * @param cb - The callback to invoke.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addHook(hook: " }, { "kind": "Reference", "text": "HookName", "canonicalReference": "obsidian-typings!HookName:type" }, { "kind": "Content", "text": ", cb: " }, { "kind": "Content", "text": "(currentNode: " }, { "kind": "Reference", "text": "Element", "canonicalReference": "!Element:interface" }, { "kind": "Content", "text": ", data: " }, { "kind": "Reference", "text": "HookEvent", "canonicalReference": "obsidian-typings!HookEvent:interface" }, { "kind": "Content", "text": ", config: " }, { "kind": "Reference", "text": "Config", "canonicalReference": "obsidian-typings!Config:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "hook", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "cb", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addHook" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#clearConfig:member(1)", "docComment": "/**\n * Clear the current configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearConfig(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearConfig" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DOMPurifyI#isSupported:member", "docComment": "/**\n * Whether DOMPurify is supported in the current environment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isSupported: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isSupported", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#isValidAttribute:member(1)", "docComment": "/**\n * Check if an attribute is valid for a given tag.\n *\n * @param tag - The tag name.\n *\n * @param attr - The attribute name.\n *\n * @param value - The attribute value.\n *\n * @returns Whether the attribute is valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isValidAttribute(tag: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", attr: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tag", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "attr", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "isValidAttribute" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#removeAllHooks:member(1)", "docComment": "/**\n * Remove all hooks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeAllHooks(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "removeAllHooks" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DOMPurifyI#removed:member", "docComment": "/**\n * Array of removed elements and attributes from the last sanitization.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removed: " }, { "kind": "Reference", "text": "DOMPurifyRemovedItem", "canonicalReference": "obsidian-typings!DOMPurifyRemovedItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "removed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#removeHook:member(1)", "docComment": "/**\n * Remove a specific hook.\n *\n * @param entryPoint - The hook name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeHook(entryPoint: " }, { "kind": "Reference", "text": "HookName", "canonicalReference": "obsidian-typings!HookName:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "entryPoint", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeHook" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#removeHooks:member(1)", "docComment": "/**\n * Remove all callbacks for a specific hook.\n *\n * @param entryPoint - The hook name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeHooks(entryPoint: " }, { "kind": "Reference", "text": "HookName", "canonicalReference": "obsidian-typings!HookName:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "entryPoint", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeHooks" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#sanitize:member(1)", "docComment": "/**\n * Sanitize a string or DOM node.\n *\n * @param source - The input to sanitize.\n *\n * @returns The sanitized string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sanitize(source: " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "sanitize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#sanitize:member(2)", "docComment": "/**\n * Sanitize a string or DOM node and return a DocumentFragment.\n *\n * @param source - The input to sanitize.\n *\n * @param config - Configuration with RETURN_DOM_FRAGMENT enabled.\n *\n * @returns The sanitized DocumentFragment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sanitize(source: " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", config: " }, { "kind": "Reference", "text": "Config", "canonicalReference": "obsidian-typings!Config:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "ConfigReturnDomFragment", "canonicalReference": "obsidian-typings!ConfigReturnDomFragment:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "DocumentFragment", "canonicalReference": "!DocumentFragment:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 }, "isOptional": false } ], "name": "sanitize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#sanitize:member(3)", "docComment": "/**\n * Sanitize a string or DOM node and return an HTMLElement.\n *\n * @param source - The input to sanitize.\n *\n * @param config - Configuration with RETURN_DOM enabled.\n *\n * @returns The sanitized HTMLElement.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sanitize(source: " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", config: " }, { "kind": "Reference", "text": "Config", "canonicalReference": "obsidian-typings!Config:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "ConfigReturnDom", "canonicalReference": "obsidian-typings!ConfigReturnDom:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 }, "isOptional": false } ], "name": "sanitize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#sanitize:member(4)", "docComment": "/**\n * Sanitize a string or DOM node with custom configuration.\n *\n * @param source - The input to sanitize.\n *\n * @param config - The sanitization configuration.\n *\n * @returns The sanitized string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sanitize(source: " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", config: " }, { "kind": "Reference", "text": "Config", "canonicalReference": "obsidian-typings!Config:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "sanitize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DOMPurifyI#setConfig:member(1)", "docComment": "/**\n * Set the configuration for DOMPurify.\n *\n * @param cfg - The configuration to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setConfig(cfg: " }, { "kind": "Reference", "text": "Config", "canonicalReference": "obsidian-typings!Config:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cfg", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setConfig" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DOMPurifyI#version:member", "docComment": "/**\n * The version of DOMPurify.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DOMPurifyRemovedItem:interface", "docComment": "/**\n * An item removed by DOMPurify during sanitization.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DOMPurifyRemovedItem " } ], "fileUrlPath": "src/dompurify/internals/DOMPurifyRemovedItem.d.ts", "releaseTag": "Public", "name": "DOMPurifyRemovedItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DOMPurifyRemovedItem#attribute:member", "docComment": "/**\n * The removed attribute, if applicable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attribute?: " }, { "kind": "Reference", "text": "Attr", "canonicalReference": "!Attr:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "attribute", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DOMPurifyRemovedItem#element:member", "docComment": "/**\n * The removed element, if applicable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "element?: " }, { "kind": "Reference", "text": "Element", "canonicalReference": "!Element:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "element", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DownloadLegacyThemeOptions:interface", "docComment": "/**\n * Options for downloading a pre-v1.0.0 legacy theme.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DownloadLegacyThemeOptions " } ], "fileUrlPath": "src/obsidian/internals/custom-css/DownloadLegacyThemeOptions.d.ts", "releaseTag": "Public", "name": "DownloadLegacyThemeOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DownloadLegacyThemeOptions#repo:member", "docComment": "/**\n * GitHub repository identifier (e.g. \"username/repo\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "repo: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "repo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Draggable:interface", "docComment": "/**\n * Represents a draggable item in the drag-and-drop system.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Draggable " } ], "fileUrlPath": "src/obsidian/internals/drag-manager/Draggable.d.ts", "releaseTag": "Public", "name": "Draggable", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Draggable#file:member", "docComment": "/**\n * Single file being dragged, if applicable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file?: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Draggable#files:member", "docComment": "/**\n * Multiple files being dragged, if applicable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "files?: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "files", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Draggable#icon:member", "docComment": "/**\n * Icon identifier for the drag ghost element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Draggable#linktext:member", "docComment": "/**\n * Link text for link-type drags.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linktext?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "linktext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Draggable#source:member", "docComment": "/**\n * Source component that initiated the drag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "source?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Draggable#sourcePath:member", "docComment": "/**\n * Path of the source file for link resolution.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourcePath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sourcePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Draggable#title:member", "docComment": "/**\n * Display title shown on the drag ghost element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Draggable#type:member", "docComment": "/**\n * Type of draggable (e.g. \"file\", \"folder\", \"link\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DragManager:interface", "docComment": "/**\n * Manager for drag-and-drop operations throughout the application.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DragManager " } ], "fileUrlPath": "src/obsidian/internals/drag-manager/DragManager.d.ts", "releaseTag": "Public", "name": "DragManager", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#actionEl:member", "docComment": "/**\n * Element displaying the current drop action label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "actionEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "actionEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getDragManagerConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#dragFile:member(1)", "docComment": "/**\n * Start a drag operation for a single file.\n *\n * @param event - The originating drag event.\n *\n * @param file - File to drag.\n *\n * @param source - Source component initiating the drag.\n *\n * @returns The created draggable item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragFile(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", source?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Draggable", "canonicalReference": "obsidian-typings!Draggable:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "dragFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#dragFiles:member(1)", "docComment": "/**\n * Start a drag operation for multiple files.\n *\n * @param event - The originating drag event.\n *\n * @param files - Files to drag.\n *\n * @param source - Source component initiating the drag.\n *\n * @returns The created draggable item, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragFiles(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ", files: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", source?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Draggable", "canonicalReference": "obsidian-typings!Draggable:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "files", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "dragFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#dragFolder:member(1)", "docComment": "/**\n * Start a drag operation for a folder.\n *\n * @param event - The originating drag event.\n *\n * @param folder - Folder to drag.\n *\n * @param source - Source component initiating the drag.\n *\n * @returns The created draggable item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragFolder(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ", folder: " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": ", source?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Draggable", "canonicalReference": "obsidian-typings!Draggable:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "folder", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "dragFolder" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#draggable:member", "docComment": "/**\n * Currently active draggable item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "draggable: " }, { "kind": "Reference", "text": "Draggable", "canonicalReference": "obsidian-typings!Draggable:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "draggable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#dragLink:member(1)", "docComment": "/**\n * Start a drag operation for a link.\n *\n * @param event - The originating drag event.\n *\n * @param linkText - Link text to drag.\n *\n * @param sourcePath - Path of the source file for link resolution.\n *\n * @param title - Display title for the drag ghost.\n *\n * @param source - Source component initiating the drag.\n *\n * @returns The created draggable item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragLink(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ", linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", sourcePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", source?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Draggable", "canonicalReference": "obsidian-typings!Draggable:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "linkText", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "sourcePath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "name": "dragLink" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#dragStart:member", "docComment": "/**\n * Information about the initial drag start event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragStart: " }, { "kind": "Reference", "text": "DragStartEvent", "canonicalReference": "obsidian-typings!DragStartEvent:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dragStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#ghostEl:member", "docComment": "/**\n * Ghost element shown while dragging.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ghostEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ghostEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#handleDrag:member(1)", "docComment": "/**\n * Register an element as a drag source with a callback to produce a draggable.\n *\n * @param el - Element to register as drag source.\n *\n * @param draggableGetter - Callback returning a draggable on drag start.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDrag(el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", draggableGetter: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Draggable", "canonicalReference": "obsidian-typings!Draggable:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "el", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "draggableGetter", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "handleDrag" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#handleDrop:member(1)", "docComment": "/**\n * Register an element as a drop target with a handler callback.\n *\n * @param el - Element to register as drop target.\n *\n * @param dropHandler - Callback invoked on drop or drag-over.\n *\n * @param draggable - Whether the element itself is also draggable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDrop(\n el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ",\n dropHandler: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ", draggable: " }, { "kind": "Reference", "text": "Draggable", "canonicalReference": "obsidian-typings!Draggable:interface" }, { "kind": "Content", "text": ", isOver: boolean) => " }, { "kind": "Reference", "text": "DropResult", "canonicalReference": "obsidian-typings!DropResult:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ",\n draggable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "el", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "dropHandler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false }, { "parameterName": "draggable", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": true } ], "name": "handleDrop" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#hideOverlay:member(1)", "docComment": "/**\n * Hide the drop zone overlay.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hideOverlay(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hideOverlay" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#hoverClass:member", "docComment": "/**\n * CSS class currently applied to the hover target.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverClass: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#hoverEl:member", "docComment": "/**\n * Element currently being hovered over during drag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#isDragOverHandled:member", "docComment": "/**\n * Whether the drag-over event has been handled by a drop target.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDragOverHandled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isDragOverHandled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#onDragEnd:member(1)", "docComment": "/**\n * Handle the end of a drag operation, cleaning up state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDragEnd(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onDragEnd" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#onDragLeave:member(1)", "docComment": "/**\n * Handle the drag-leave event on a drop target.\n *\n * @param event - The drag-leave event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDragLeave(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDragLeave" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#onDragOver:member(1)", "docComment": "/**\n * Handle the drag-over event to update hover state.\n *\n * @param event - The drag-over event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDragOver(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDragOver" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#onDragOverFirst:member(1)", "docComment": "/**\n * Handle the first drag-over event when entering a drop zone.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDragOverFirst(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onDragOverFirst" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#onDragStart:member(1)", "docComment": "/**\n * Handle the start of a drag operation with a draggable item.\n *\n * @param event - The drag event.\n *\n * @param draggable - The draggable item being dragged.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDragStart(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ", draggable: " }, { "kind": "Reference", "text": "Draggable", "canonicalReference": "obsidian-typings!Draggable:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "draggable", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onDragStart" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#onDragStartGlobal:member(1)", "docComment": "/**\n * Handle a global drag start event.\n *\n * @param event - The drag event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDragStartGlobal(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDragStartGlobal" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#onTouchEnd:member(1)", "docComment": "/**\n * Handle touch end event for mobile drag operations.\n *\n * @param event - The touch event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTouchEnd(event: " }, { "kind": "Reference", "text": "TouchEvent", "canonicalReference": "!TouchEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onTouchEnd" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#overlayEl:member", "docComment": "/**\n * Overlay element shown during drag operations to indicate drop zones.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overlayEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "overlayEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#removeOverlay:member(1)", "docComment": "/**\n * Remove the drop zone overlay element from the DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeOverlay(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "removeOverlay" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#setAction:member(1)", "docComment": "/**\n * Set the current drop action label.\n *\n * @param action - Action label text, or `null` to clear.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAction(action: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setAction" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#shouldHideOverlay:member", "docComment": "/**\n * Whether the overlay should be hidden on the next update.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shouldHideOverlay: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "shouldHideOverlay", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#showOverlay:member(1)", "docComment": "/**\n * Show the drop zone overlay at the specified position.\n *\n * @param doc - Document in which to show the overlay.\n *\n * @param rect - Rectangle defining the overlay position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showOverlay(doc: " }, { "kind": "Reference", "text": "Document", "canonicalReference": "!Document:interface" }, { "kind": "Content", "text": ", rect: " }, { "kind": "Reference", "text": "DOMRect", "canonicalReference": "!DOMRect:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "doc", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showOverlay" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#sourceClass:member", "docComment": "/**\n * CSS class applied to the source elements during drag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourceClass: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sourceClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragManager#sourceEls:member", "docComment": "/**\n * Elements from which the drag originated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourceEls: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "[] | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sourceEls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#updateHover:member(1)", "docComment": "/**\n * Update the hover target element and its CSS class.\n *\n * @param hoverEl - Element to highlight as hover target, or `null`.\n *\n * @param hoverClass - CSS class to apply to the hover element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateHover(hoverEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", hoverClass: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "hoverEl", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "hoverClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "updateHover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!DragManager#updateSource:member(1)", "docComment": "/**\n * Update the drag source elements and their CSS class.\n *\n * @param sourceEls - Source elements, or `null`.\n *\n * @param sourceClass - CSS class to apply to source elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateSource(sourceEls: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "[] | null" }, { "kind": "Content", "text": ", sourceClass: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "sourceEls", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "sourceClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "updateSource" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DragStartEvent:interface", "docComment": "/**\n * Information about the initial drag start event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DragStartEvent " } ], "fileUrlPath": "src/obsidian/internals/drag-manager/DragStartEvent.d.ts", "releaseTag": "Public", "name": "DragStartEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragStartEvent#evt:member", "docComment": "/**\n * The original drag event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "evt: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "evt", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DragStartEvent#moved:member", "docComment": "/**\n * Whether the dragged item has moved from its starting position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moved: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "moved", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!DropResult:interface", "docComment": "/**\n * Result returned from a drop handler indicating the outcome of a drop operation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DropResult " } ], "fileUrlPath": "src/obsidian/internals/drag-manager/DropResult.d.ts", "releaseTag": "Public", "name": "DropResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DropResult#action:member", "docComment": "/**\n * Action identifier describing what happened on drop (e.g. \"link\", \"move\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "action: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "action", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DropResult#dropEffect:member", "docComment": "/**\n * The drop effect to apply to the drag event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropEffect: " }, { "kind": "Content", "text": "'copy' | 'link' | 'move' | 'none'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropEffect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DropResult#hoverClass:member", "docComment": "/**\n * CSS class to apply to the hover target element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverClass?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hoverClass", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!DropResult#hoverEl:member", "docComment": "/**\n * Element to highlight as the current drop target.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverEl?: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hoverEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EdgeIndex:interface", "docComment": "/**\n * Spatial index (R-tree) for efficient hit-testing and spatial queries on canvas edges and nodes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EdgeIndex extends " }, { "kind": "Reference", "text": "EdgeIndexBase", "canonicalReference": "obsidian-typings!EdgeIndexBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/EdgeIndex.d.ts", "releaseTag": "Public", "name": "EdgeIndex", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EdgeIndex#_maxEntries:member", "docComment": "/**\n * Maximum number of entries per R-tree node before splitting.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_maxEntries: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_maxEntries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EdgeIndex#_minEntries:member", "docComment": "/**\n * Minimum number of entries per R-tree node before merging.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_minEntries: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_minEntries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndex#compareMinX:member(1)", "docComment": "/**\n * Compare two items by their minimum X coordinate for sorting.\n *\n * @returns The comparison result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compareMinX(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "compareMinX" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndex#compareMinY:member(1)", "docComment": "/**\n * Compare two items by their minimum Y coordinate for sorting.\n *\n * @returns The comparison result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compareMinY(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "compareMinY" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EdgeIndex#data:member", "docComment": "/**\n * Root data node of the R-tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "EdgeIndexData", "canonicalReference": "obsidian-typings!EdgeIndexData:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EdgeIndexBase:interface", "docComment": "/**\n * Base interface for the spatial edge index, extending the R-tree with custom insert/remove behavior.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EdgeIndexBase extends " }, { "kind": "Reference", "text": "EdgeIndexBaseBase", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/EdgeIndexBase.d.ts", "releaseTag": "Public", "name": "EdgeIndexBase", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBase#insert:member(1)", "docComment": "/**\n * Insert an item into the spatial index.\n *\n * @returns The updated index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insert(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "insert" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBase#remove:member(1)", "docComment": "/**\n * Remove an item from the spatial index.\n *\n * @returns The updated index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "remove" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBase#toBBox:member(1)", "docComment": "/**\n * Convert an item to its bounding box representation.\n *\n * @returns The bounding box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toBBox(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toBBox" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase:interface", "docComment": "/**\n * R-tree spatial index base implementation for efficient spatial queries on canvas elements.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EdgeIndexBaseBase " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/EdgeIndexBaseBase.d.ts", "releaseTag": "Public", "name": "EdgeIndexBaseBase", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_adjustParentBBoxes:member(1)", "docComment": "/**\n * Adjust parent bounding boxes after an insertion or modification.\n *\n * @returns The result of adjusting parent bounding boxes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_adjustParentBBoxes(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "_adjustParentBBoxes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_all:member(1)", "docComment": "/**\n * Traverse all items in the tree, calling the callback for each.\n *\n * @returns The result of traversing all items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_all(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "_all" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_allDistMargin:member(1)", "docComment": "/**\n * Calculate the distribution margin for all possible splits along an axis.\n *\n * @returns The distribution margin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_allDistMargin(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg4: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "arg4", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "_allDistMargin" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_build:member(1)", "docComment": "/**\n * Build the R-tree from a set of items.\n *\n * @returns The built R-tree node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_build(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg4: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "arg4", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "_build" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_chooseSplitAxis:member(1)", "docComment": "/**\n * Choose the best axis for splitting an overflowing node.\n *\n * @returns The result of choosing the split axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_chooseSplitAxis(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "_chooseSplitAxis" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_chooseSplitIndex:member(1)", "docComment": "/**\n * Choose the best split index along the chosen axis.\n *\n * @returns The best split index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_chooseSplitIndex(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "_chooseSplitIndex" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_chooseSubtree:member(1)", "docComment": "/**\n * Choose the best subtree for inserting a new item.\n *\n * @returns The chosen subtree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_chooseSubtree(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg4: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "arg4", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "_chooseSubtree" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_condense:member(1)", "docComment": "/**\n * Condense the tree by removing empty branches after a deletion.\n *\n * @returns The result of condensing the tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_condense(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "_condense" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_insert:member(1)", "docComment": "/**\n * Internal insert method that places an item at the specified tree level.\n *\n * @returns The result of inserting the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_insert(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "_insert" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_split:member(1)", "docComment": "/**\n * Split an overflowing tree node into two nodes.\n *\n * @returns The result of splitting the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_split(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "_split" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#_splitRoot:member(1)", "docComment": "/**\n * Split the root node when it overflows.\n *\n * @returns The result of splitting the root.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_splitRoot(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "_splitRoot" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#all:member(1)", "docComment": "/**\n * Return all items stored in the index.\n *\n * @returns All items in the index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "all(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "all" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#clear:member(1)", "docComment": "/**\n * Remove all items from the index.\n *\n * @returns The cleared index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#collides:member(1)", "docComment": "/**\n * Check whether any items in the index collide with the given bounding box.\n *\n * @returns Whether a collision was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collides(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "collides" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#compareMinX:member(1)", "docComment": "/**\n * Compare two items by their minimum X coordinate for sorting.\n *\n * @returns The comparison result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compareMinX(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "compareMinX" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#compareMinY:member(1)", "docComment": "/**\n * Compare two items by their minimum Y coordinate for sorting.\n *\n * @returns The comparison result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compareMinY(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "compareMinY" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#fromJSON:member(1)", "docComment": "/**\n * Load the index state from a JSON representation.\n *\n * @returns The loaded index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromJSON(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "fromJSON" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#insert:member(1)", "docComment": "/**\n * Insert an item into the spatial index.\n *\n * @returns The updated index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insert(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "insert" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#load:member(1)", "docComment": "/**\n * Bulk-load a set of items into the index.\n *\n * @returns The updated index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "load(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "load" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#remove:member(1)", "docComment": "/**\n * Remove an item from the index, optionally using a custom equality function.\n *\n * @returns The updated index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "remove" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#search:member(1)", "docComment": "/**\n * Search for all items that intersect the given bounding box.\n *\n * @returns The matching items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "search(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "search" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#toBBox:member(1)", "docComment": "/**\n * Convert an item to its bounding box representation.\n *\n * @returns The bounding box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toBBox(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toBBox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EdgeIndexBaseBase#toJSON:member(1)", "docComment": "/**\n * Serialize the index state to a JSON representation.\n *\n * @returns The JSON representation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toJSON(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toJSON" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EdgeIndexData:interface", "docComment": "/**\n * Node in the spatial index (R-tree) for canvas edges.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EdgeIndexData extends " }, { "kind": "Reference", "text": "BBox", "canonicalReference": "obsidian-typings!BBox:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/EdgeIndexData.d.ts", "releaseTag": "Public", "name": "EdgeIndexData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EdgeIndexData#children:member", "docComment": "/**\n * Child edges contained in this index node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "children: " }, { "kind": "Reference", "text": "CanvasViewCanvasEdge", "canonicalReference": "obsidian-typings!CanvasViewCanvasEdge:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EdgeIndexData#height:member", "docComment": "/**\n * Height of the subtree rooted at this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EdgeIndexData#leaf:member", "docComment": "/**\n * Whether this is a leaf node in the index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "leaf: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "leaf", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorLanguageSupport:interface", "docComment": "/**\n * {@link obsidian#Editor} language support.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorLanguageSupport " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/EditorLanguageSupport.d.ts", "releaseTag": "Public", "name": "EditorLanguageSupport", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorRangeEx:interface", "docComment": "/**\n * An extended editor range with nullable start and end positions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorRangeEx " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorRangeEx.d.ts", "releaseTag": "Public", "name": "EditorRangeEx", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorRangeEx#from:member", "docComment": "/**\n * Start position of the range, or null if unset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorRangeEx#to:member", "docComment": "/**\n * End position of the range, or null if unset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorSearchComponent:interface", "docComment": "/**\n * Search component embedded in the editor for find-and-replace functionality.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorSearchComponent extends " }, { "kind": "Reference", "text": "AbstractSearchComponent", "canonicalReference": "obsidian-typings!AbstractSearchComponent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/components/EditorSearchComponent.d.ts", "releaseTag": "Public", "name": "EditorSearchComponent", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#clear:member(1)", "docComment": "/**\n * Remove all highlights from editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#cursor:member", "docComment": "/**\n * Search cursor for editor, handles search and replace functionality for editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursor: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SearchCursor", "canonicalReference": "obsidian-typings!SearchCursor:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cursor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#editor:member", "docComment": "/**\n * Linked editor for search component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editor: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "editor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#findNext:member(1)", "docComment": "/**\n * Find next search results from cursor and highlights it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findNext(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findNext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#findNextOrReplace:member(1)", "docComment": "/**\n * Replace cursor with replacement string if not `null` and moves to next search result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findNextOrReplace(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findNextOrReplace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#findPrevious:member(1)", "docComment": "/**\n * Find previous search results from cursor and highlights it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findPrevious(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findPrevious" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#hide:member(1)", "docComment": "/**\n * Hide/detaches the search component and removes cursor highlights.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hide(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hide" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#highlight:member(1)", "docComment": "/**\n * Add highlights for specified ranges.\n *\n * @param ranges - The editor ranges to highlight.\n *\n * @remark\n *\n * Invokes editor.addHighlights.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlight(ranges: " }, { "kind": "Reference", "text": "EditorRange", "canonicalReference": "obsidian!EditorRange:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ranges", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "highlight" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#isActive:member", "docComment": "/**\n * Whether search component is currently rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isActive: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isActive", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#isReplace:member", "docComment": "/**\n * Whether search component is replacing text (includes 'Replace' input field).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isReplace: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isReplace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#onAltEnter:member(1)", "docComment": "/**\n * Highlights all matches if search element focused.\n *\n * @param e - The keyboard event that triggered the action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onAltEnter(e?: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "onAltEnter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#onModAltEnter:member(1)", "docComment": "/**\n * Replace all search results with specified text if replace mode and replacement element is focused.\n *\n * @param e - The keyboard event that triggered the action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onModAltEnter(e?: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "onModAltEnter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#onSearchInput:member(1)", "docComment": "/**\n * Updates search cursor on new input query and highlights search results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSearchInput(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onSearchInput" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#replaceAll:member(1)", "docComment": "/**\n * Replaces all search results with replacement query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "replaceAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#replaceCurrentMatch:member(1)", "docComment": "/**\n * Replace current search result, if any, with replacement query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceCurrentMatch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "replaceCurrentMatch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#searchAll:member(1)", "docComment": "/**\n * Find all matches of search query and highlights them.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "searchAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSearchComponent#show:member(1)", "docComment": "/**\n * Reveal the search (and replace) component.\n *\n * @param replace - Whether to show the replace input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "show(replace: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replace", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "show" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorStateSelectionSpec:interface", "docComment": "/**\n * A selection specified as an anchor position and optional head position.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorStateSelectionSpec " } ], "fileUrlPath": "src/@codemirror__state/internals/EditorStateSelectionSpec.d.ts", "releaseTag": "Public", "name": "EditorStateSelectionSpec", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorStateSelectionSpec#anchor:member", "docComment": "/**\n * The anchor position of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "anchor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "anchor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorStateSelectionSpec#head:member", "docComment": "/**\n * The head position of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "head?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "head", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorStatusPlugin:interface", "docComment": "/**\n * Internal plugin registration for the editor status bar feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorStatusPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EditorStatusPluginInstance", "canonicalReference": "obsidian-typings!EditorStatusPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/editor-status/EditorStatusPlugin.d.ts", "releaseTag": "Public", "name": "EditorStatusPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorStatusPluginInstance:interface", "docComment": "/**\n * Plugin instance for editor status, displaying editor information in the status bar.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorStatusPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EditorStatusPlugin", "canonicalReference": "obsidian-typings!EditorStatusPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/editor-status/EditorStatusPluginInstance.d.ts", "releaseTag": "Public", "name": "EditorStatusPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorStatusPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorStatusPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorStatusPluginInstance#hiddenFromList:member", "docComment": "/**\n * Whether this plugin is hidden from the plugin list in settings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hiddenFromList: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hiddenFromList", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorStatusPluginInstance#plugin:member", "docComment": "/**\n * Reference to the editor status plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "EditorStatusPlugin", "canonicalReference": "obsidian-typings!EditorStatusPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorSuggestEx:interface", "docComment": "/**\n * Extended editor suggest interface for managing editor suggestion providers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorSuggestEx " } ], "fileUrlPath": "src/obsidian/internals/EditorSuggestEx.d.ts", "releaseTag": "Public", "name": "EditorSuggestEx", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#addSuggest:member(1)", "docComment": "/**\n * Registers an editor suggestion provider.\n *\n * @param suggest - The provider to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSuggest(suggest: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "suggest", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "addSuggest" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#close:member(1)", "docComment": "/**\n * Closes the active suggestion provider.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "close" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#currentSuggest:member", "docComment": "/**\n * Currently active and rendered editor suggestion popup.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "currentSuggest?: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "currentSuggest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#isShowingSuggestion:member(1)", "docComment": "/**\n * Checks whether a suggestion popup is currently shown.\n *\n * @returns Whether a suggestion is showing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isShowingSuggestion(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isShowingSuggestion" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#removeSuggest:member(1)", "docComment": "/**\n * Unregisters an editor suggestion provider.\n *\n * @param suggest - The provider to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeSuggest(suggest: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "suggest", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "removeSuggest" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#reposition:member(1)", "docComment": "/**\n * Repositions the active suggestion popup.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reposition(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reposition" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#setCurrentSuggest:member(1)", "docComment": "/**\n * Sets the active suggestion provider, closing the previous one.\n *\n * @param suggest - The provider to activate, or `null` to clear.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCurrentSuggest(suggest: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown> | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "suggest", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "setCurrentSuggest" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#suggests:member", "docComment": "/**\n * Registered editor suggestion providers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suggests: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown>[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggests", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggestEx#trigger:member(1)", "docComment": "/**\n * Triggers the registered suggestion providers at the cursor.\n *\n * @param editor - The editor.\n *\n * @param file - The file being edited.\n *\n * @param force - Whether to force the suggestion popup open.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trigger(editor: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", force: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "force", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "trigger" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorSuggests:interface", "docComment": "/**\n * Manager for editor suggestion popups providing autocompletion in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorSuggests " } ], "fileUrlPath": "src/obsidian/internals/EditorSuggests.d.ts", "releaseTag": "Public", "name": "EditorSuggests", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggests#addSuggest:member(1)", "docComment": "/**\n * Add a new editor suggestion to the list of registered suggestion providers.\n *\n * @param suggest - Suggestion provider to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSuggest(suggest: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "suggest", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "addSuggest" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggests#close:member(1)", "docComment": "/**\n * Close the currently active editor suggestion popup.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "close" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggests#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getEditorSuggestsConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorSuggests#currentSuggest:member", "docComment": "/**\n * Currently active and rendered editor suggestion popup.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "currentSuggest: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown> | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "currentSuggest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggests#isShowingSuggestion:member(1)", "docComment": "/**\n * Whether there is a editor suggestion popup active and visible.\n *\n * @returns Whether a suggestion popup is visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isShowingSuggestion(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isShowingSuggestion" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggests#removeSuggest:member(1)", "docComment": "/**\n * Remove a registered editor suggestion from the list of registered suggestion providers.\n *\n * @param suggest - Suggestion provider to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeSuggest(suggest: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "suggest", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "removeSuggest" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggests#reposition:member(1)", "docComment": "/**\n * Update position of currently active and rendered editor suggestion popup.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reposition(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reposition" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggests#setCurrentSuggest:member(1)", "docComment": "/**\n * Set the currently active editor suggestion popup to specified suggester.\n *\n * @param suggest - Suggestion provider to activate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCurrentSuggest(suggest: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "suggest", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "setCurrentSuggest" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorSuggests#suggests:member", "docComment": "/**\n * Registered editor suggestions.\n *\n * @remark\n *\n * Used for providing autocompletions for specific strings.\n *\n * @tutorial\n *\n * Reference official documentation under EditorSuggest<T> for usage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suggests: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<unknown>[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggests", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EditorSuggests#trigger:member(1)", "docComment": "/**\n * Run check on focused editor to see whether a suggestion should be triggered and rendered.\n *\n * @param editor - The editor view.\n *\n * @param t - The file being edited.\n *\n * @param n - Whether to force trigger.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trigger(editor: " }, { "kind": "Reference", "text": "MarkdownBaseView", "canonicalReference": "obsidian-typings!MarkdownBaseView:interface" }, { "kind": "Content", "text": ", t: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "trigger" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewCoords:interface", "docComment": "/**\n * Screen coordinates with x and y values.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewCoords " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewCoords.d.ts", "releaseTag": "Public", "name": "EditorViewCoords", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewCoords#x:member", "docComment": "/**\n * The x coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewCoords#y:member", "docComment": "/**\n * The y coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewDocumentPadding:interface", "docComment": "/**\n * Padding above and below the document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewDocumentPadding " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewDocumentPadding.d.ts", "releaseTag": "Public", "name": "EditorViewDocumentPadding", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewDocumentPadding#bottom:member", "docComment": "/**\n * The bottom padding in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewDocumentPadding#top:member", "docComment": "/**\n * The top padding in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewDomPosition:interface", "docComment": "/**\n * A DOM position with a node and offset.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewDomPosition " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewDomPosition.d.ts", "releaseTag": "Public", "name": "EditorViewDomPosition", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewDomPosition#node:member", "docComment": "/**\n * The DOM node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "node: " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "node", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewDomPosition#offset:member", "docComment": "/**\n * The offset within the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewRange:interface", "docComment": "/**\n * A range defined by from and to positions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewRange " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewRange.d.ts", "releaseTag": "Public", "name": "EditorViewRange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewRange#from:member", "docComment": "/**\n * The start position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewRange#to:member", "docComment": "/**\n * The end position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewScrollHandlerOptions:interface", "docComment": "/**\n * Options for the scroll handler facet.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewScrollHandlerOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewScrollHandlerOptions.d.ts", "releaseTag": "Public", "name": "EditorViewScrollHandlerOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewScrollHandlerOptions#x:member", "docComment": "/**\n * Horizontal alignment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "'center' | 'end' | 'nearest' | 'start'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewScrollHandlerOptions#xMargin:member", "docComment": "/**\n * Horizontal margin in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "xMargin: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "xMargin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewScrollHandlerOptions#y:member", "docComment": "/**\n * Vertical alignment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "'center' | 'end' | 'nearest' | 'start'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewScrollHandlerOptions#yMargin:member", "docComment": "/**\n * Vertical margin in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "yMargin: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "yMargin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewScrollIntoViewOptions:interface", "docComment": "/**\n * Options for scrolling into view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewScrollIntoViewOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewScrollIntoViewOptions.d.ts", "releaseTag": "Public", "name": "EditorViewScrollIntoViewOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewScrollIntoViewOptions#x:member", "docComment": "/**\n * Horizontal alignment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x?: " }, { "kind": "Content", "text": "'center' | 'end' | 'nearest' | 'start'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewScrollIntoViewOptions#xMargin:member", "docComment": "/**\n * Horizontal margin in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "xMargin?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "xMargin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewScrollIntoViewOptions#y:member", "docComment": "/**\n * Vertical alignment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y?: " }, { "kind": "Content", "text": "'center' | 'end' | 'nearest' | 'start'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewScrollIntoViewOptions#yMargin:member", "docComment": "/**\n * Vertical margin in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "yMargin?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "yMargin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewState:interface", "docComment": "/**\n * Internal view state of the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewState " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewState.d.ts", "releaseTag": "Public", "name": "EditorViewState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewState#printing:member", "docComment": "/**\n * Whether the editor is currently in printing mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "printing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "printing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewThemeOptions:interface", "docComment": "/**\n * Options for creating a theme.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewThemeOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewThemeOptions.d.ts", "releaseTag": "Public", "name": "EditorViewThemeOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EditorViewThemeOptions#dark:member", "docComment": "/**\n * Whether this is a dark theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dark?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "dark", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EditorViewThemeSpec:interface", "docComment": "/**\n * A record of CSS selectors to style values for theme definitions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditorViewThemeSpec " } ], "fileUrlPath": "src/@codemirror__view/internals/EditorViewThemeSpec.d.ts", "releaseTag": "Public", "name": "EditorViewThemeSpec", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!EditorViewThemeSpec:index(1)", "docComment": "/**\n * A style value for a CSS selector.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[selector: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "selector", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions:interface", "docComment": "/**\n * Options for the application's about panel.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronAboutPanelOptionsOptions " } ], "fileUrlPath": "src/electron/internals/ElectronAboutPanelOptionsOptions.d.ts", "releaseTag": "Public", "name": "ElectronAboutPanelOptionsOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions#applicationName:member", "docComment": "/**\n * The app's name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applicationName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "applicationName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions#applicationVersion:member", "docComment": "/**\n * The app's version.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applicationVersion?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "applicationVersion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions#authors:member", "docComment": "/**\n * List of app authors. Linux only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authors?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "authors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions#copyright:member", "docComment": "/**\n * Copyright information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copyright?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "copyright", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions#credits:member", "docComment": "/**\n * Credit information. macOS and Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "credits?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "credits", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions#iconPath:member", "docComment": "/**\n * Path to the app's icon in a JPEG or PNG file format. Linux and Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "iconPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions#version:member", "docComment": "/**\n * The app's build version number. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions#website:member", "docComment": "/**\n * The app's website. Linux only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "website?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "website", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ElectronAccelerator:type", "docComment": "/**\n * Electron Accelerator, a string representing a keyboard shortcut.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ElectronAccelerator = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/electron/internals/ElectronAccelerator.d.ts", "releaseTag": "Public", "name": "ElectronAccelerator", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronAddRepresentationOptions:interface", "docComment": "/**\n * Options for `NativeImage.addRepresentation`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronAddRepresentationOptions " } ], "fileUrlPath": "src/electron/internals/ElectronAddRepresentationOptions.d.ts", "releaseTag": "Public", "name": "ElectronAddRepresentationOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAddRepresentationOptions#buffer:member", "docComment": "/**\n * The buffer containing the raw image data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buffer?: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "buffer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAddRepresentationOptions#dataURL:member", "docComment": "/**\n * The data URL containing either a base 64 encoded PNG or JPEG image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dataURL?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "dataURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAddRepresentationOptions#height:member", "docComment": "/**\n * The height of the image representation. Required if a bitmap buffer is specified as `buffer`.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAddRepresentationOptions#scaleFactor:member", "docComment": "/**\n * The scale factor to add the image representation for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleFactor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAddRepresentationOptions#width:member", "docComment": "/**\n * The width of the image representation. Required if a bitmap buffer is specified as `buffer`.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronAnimationSettings:interface", "docComment": "/**\n * Describes the system-wide animation settings.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronAnimationSettings " } ], "fileUrlPath": "src/electron/internals/ElectronAnimationSettings.d.ts", "releaseTag": "Public", "name": "ElectronAnimationSettings", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAnimationSettings#prefersReducedMotion:member", "docComment": "/**\n * Determines whether the user desires reduced motion based on platform APIs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prefersReducedMotion: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "prefersReducedMotion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAnimationSettings#scrollAnimationsEnabledBySystem:member", "docComment": "/**\n * Determines on a per-platform basis whether scroll animations (e.g. produced by home/end key) should be enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollAnimationsEnabledBySystem: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scrollAnimationsEnabledBySystem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAnimationSettings#shouldRenderRichAnimation:member", "docComment": "/**\n * Returns `true` if rich animations should be rendered. Looks at session type (e.g. remote desktop) and accessibility settings to give guidance for heavy animations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shouldRenderRichAnimation: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "shouldRenderRichAnimation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronApp:interface", "docComment": "/**\n * Electron App for controlling the application lifecycle.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronApp " } ], "fileUrlPath": "src/electron/internals/ElectronApp.d.ts", "releaseTag": "Public", "name": "ElectronApp", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#accessibilitySupportEnabled:member", "docComment": "/**\n * Whether Chrome's accessibility support is enabled. Setting this to `true` manually enables accessibility support. Must be set after the `ready` event is emitted. macOS and Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accessibilitySupportEnabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "accessibilitySupportEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(1)", "docComment": "/**\n * Adds a listener for the `accessibility-support-changed` event.\n *\n * Emitted when Chrome's accessibility support changes. macOS and Windows only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'accessibility-support-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", accessibilitySupportEnabled: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(10)", "docComment": "/**\n * Adds a listener for the `continue-activity` event.\n *\n * Emitted during Handoff when an activity from a different device wants to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'continue-activity'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown, details: " }, { "kind": "Reference", "text": "ElectronContinueActivityDetails", "canonicalReference": "obsidian-typings!ElectronContinueActivityDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(11)", "docComment": "/**\n * Adds a listener for the `continue-activity-error` event.\n *\n * Emitted during Handoff when an activity from a different device fails to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'continue-activity-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, error: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(12)", "docComment": "/**\n * Adds a listener for the `did-become-active` event.\n *\n * Emitted every time the app becomes active. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-become-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(13)", "docComment": "/**\n * Adds a listener for the `first-instance-ack` event.\n *\n * Emitted in the second instance during `requestSingleInstanceLock` when the first instance calls the `ackCallback`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'first-instance-ack'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", additionalData: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(14)", "docComment": "/**\n * Adds a listener for the `gpu-info-update` event.\n *\n * Emitted whenever there is a GPU info update.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'gpu-info-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(15)", "docComment": "/**\n * Adds a listener for the `gpu-process-crashed` event.\n *\n * Emitted when the GPU process crashes or is killed.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'gpu-process-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(16)", "docComment": "/**\n * Adds a listener for the `login` event.\n *\n * Emitted when `webContents` wants to do basic auth.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", authenticationResponseDetails: " }, { "kind": "Reference", "text": "ElectronAuthenticationResponseDetails", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface" }, { "kind": "Content", "text": ", authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(17)", "docComment": "/**\n * Adds a listener for the `new-window-for-tab` event.\n *\n * Emitted when the user clicks the native macOS new tab button. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'new-window-for-tab'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(18)", "docComment": "/**\n * Adds a listener for the `open-file` event.\n *\n * Emitted when the user wants to open a file with the application. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'open-file'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", path: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(19)", "docComment": "/**\n * Adds a listener for the `open-url` event.\n *\n * Emitted when the user wants to open a URL with the application. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'open-url'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(2)", "docComment": "/**\n * Adds a listener for the `activate` event.\n *\n * Emitted when the application is activated. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'activate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", hasVisibleWindows: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(20)", "docComment": "/**\n * Adds a listener for the `quit` event.\n *\n * Emitted when the application is quitting.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", exitCode: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(21)", "docComment": "/**\n * Adds a listener for the `ready` event.\n *\n * Emitted once, when Electron has finished initializing.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", launchInfo: " }, { "kind": "Reference", "text": "ElectronNotificationResponse", "canonicalReference": "obsidian-typings!ElectronNotificationResponse:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(22)", "docComment": "/**\n * Adds a listener for the `render-process-gone` event.\n *\n * Emitted when the renderer process unexpectedly disappears.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'render-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRenderProcessGoneDetails", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(23)", "docComment": "/**\n * Adds a listener for the `renderer-process-crashed` event.\n *\n * Emitted when the renderer process of `webContents` crashes or is killed.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'renderer-process-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(24)", "docComment": "/**\n * Adds a listener for the `second-instance` event.\n *\n * Emitted inside the primary instance when a second instance is executed and calls `requestSingleInstanceLock`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'second-instance'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", argv: string[], workingDirectory: string, additionalData: unknown, ackCallback: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(25)", "docComment": "/**\n * Adds a listener for the `select-client-certificate` event.\n *\n * Emitted when a client certificate is requested.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'select-client-certificate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", url: string, certificateList: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": "[], callback: (certificate?: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(26)", "docComment": "/**\n * Adds a listener for the `session-created` event.\n *\n * Emitted when Electron has created a new `session`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'session-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(session: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(27)", "docComment": "/**\n * Adds a listener for the `update-activity-state` event.\n *\n * Emitted when Handoff is about to be resumed on another device. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'update-activity-state'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(28)", "docComment": "/**\n * Adds a listener for the `web-contents-created` event.\n *\n * Emitted when a new `webContents` is created.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'web-contents-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(29)", "docComment": "/**\n * Adds a listener for the `will-continue-activity` event.\n *\n * Emitted during Handoff before an activity from a different device wants to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-continue-activity'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(3)", "docComment": "/**\n * Adds a listener for the `activity-was-continued` event.\n *\n * Emitted during Handoff after an activity from this device was successfully resumed on another one. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'activity-was-continued'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(30)", "docComment": "/**\n * Adds a listener for the `will-finish-launching` event.\n *\n * Emitted when the application has finished basic startup.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-finish-launching'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(31)", "docComment": "/**\n * Adds a listener for the `will-quit` event.\n *\n * Emitted when all windows have been closed and the application will quit.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(32)", "docComment": "/**\n * Adds a listener for the `window-all-closed` event.\n *\n * Emitted when all windows have been closed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'window-all-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(4)", "docComment": "/**\n * Adds a listener for the `before-quit` event.\n *\n * Emitted before the application starts closing its windows.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'before-quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(5)", "docComment": "/**\n * Adds a listener for the `browser-window-blur` event.\n *\n * Emitted when a browserWindow gets blurred.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'browser-window-blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(6)", "docComment": "/**\n * Adds a listener for the `browser-window-created` event.\n *\n * Emitted when a new browserWindow is created.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'browser-window-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(7)", "docComment": "/**\n * Adds a listener for the `browser-window-focus` event.\n *\n * Emitted when a browserWindow gets focused.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'browser-window-focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(8)", "docComment": "/**\n * Adds a listener for the `certificate-error` event.\n *\n * Emitted when failed to verify the certificate for a URL.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'certificate-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", url: string, error: string, certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ", callback: (isTrusted: boolean) => void, isMainFrame: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addListener:member(9)", "docComment": "/**\n * Adds a listener for the `child-process-gone` event.\n *\n * Emitted when the child process unexpectedly disappears.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'child-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronDetails", "canonicalReference": "obsidian-typings!ElectronDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#addRecentDocument:member(1)", "docComment": "/**\n * Adds `path` to the recent documents list. macOS and Windows only.\n *\n * @param path - The path to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addRecentDocument(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addRecentDocument" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#applicationMenu:member", "docComment": "/**\n * The application menu, or `null` if none has been set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applicationMenu: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "applicationMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#badgeCount:member", "docComment": "/**\n * The badge count for the current app. Setting the count to `0` hides the badge. Linux and macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "badgeCount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "badgeCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#clearRecentDocuments:member(1)", "docComment": "/**\n * Clears the recent documents list. macOS and Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearRecentDocuments(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearRecentDocuments" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#commandLine:member", "docComment": "/**\n * Reads and manipulates the command line arguments that Chromium uses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly commandLine: " }, { "kind": "Reference", "text": "ElectronCommandLine", "canonicalReference": "obsidian-typings!ElectronCommandLine:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "commandLine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#configureHostResolver:member(1)", "docComment": "/**\n * Configures host resolution (DNS and DNS-over-HTTPS). Must be called after the `ready` event.\n *\n * @param options - The host resolver options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "configureHostResolver(options: " }, { "kind": "Reference", "text": "ElectronConfigureHostResolverOptions", "canonicalReference": "obsidian-typings!ElectronConfigureHostResolverOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "configureHostResolver" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#disableDomainBlockingFor3DAPIs:member(1)", "docComment": "/**\n * Disables the per-domain blocking of 3D APIs after repeated GPU process crashes. Can only be called before the app is ready.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableDomainBlockingFor3DAPIs(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "disableDomainBlockingFor3DAPIs" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#disableHardwareAcceleration:member(1)", "docComment": "/**\n * Disables hardware acceleration for the current app. Can only be called before the app is ready.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableHardwareAcceleration(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "disableHardwareAcceleration" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#dock:member", "docComment": "/**\n * Performs actions on the app icon in the user's dock. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly dock: " }, { "kind": "Reference", "text": "ElectronDock", "canonicalReference": "obsidian-typings!ElectronDock:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "dock", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#enableSandbox:member(1)", "docComment": "/**\n * Enables full sandbox mode on the app. Can only be called before the app is ready.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableSandbox(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "enableSandbox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#exit:member(1)", "docComment": "/**\n * Exits immediately with `exitCode`. All windows are closed immediately without asking the user, and the `before-quit` and `will-quit` events are not emitted.\n *\n * @param exitCode - The exit code.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exit(exitCode?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "exitCode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "exit" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#focus:member(1)", "docComment": "/**\n * Focuses the app. On Linux, focuses the first visible window; on macOS, makes the app active; on Windows, focuses the app's first window.\n *\n * @param options - The focus options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(options?: " }, { "kind": "Reference", "text": "ElectronFocusOptions", "canonicalReference": "obsidian-typings!ElectronFocusOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getApplicationInfoForProtocol:member(1)", "docComment": "/**\n * Returns the application name, icon and path of the default handler for the protocol of a URL. macOS and Windows only.\n *\n * @param url - The URL whose protocol handler to look up.\n *\n * @returns A promise resolved with the handler information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getApplicationInfoForProtocol(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronApplicationInfoForProtocolReturnValue", "canonicalReference": "obsidian-typings!ElectronApplicationInfoForProtocolReturnValue:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getApplicationInfoForProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getApplicationNameForProtocol:member(1)", "docComment": "/**\n * Returns the application name of the default handler for the protocol of a URL.\n *\n * @param url - The URL whose protocol handler to look up.\n *\n * @returns The handler application name, or an empty string if there is no handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getApplicationNameForProtocol(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getApplicationNameForProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getAppMetrics:member(1)", "docComment": "/**\n * Returns memory and CPU usage statistics of all the processes associated with the app.\n *\n * @returns The array of process metrics.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAppMetrics(): " }, { "kind": "Reference", "text": "ElectronProcessMetric", "canonicalReference": "obsidian-typings!ElectronProcessMetric:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAppMetrics" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getAppPath:member(1)", "docComment": "/**\n * Returns the current application directory.\n *\n * @returns The application directory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAppPath(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAppPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getBadgeCount:member(1)", "docComment": "/**\n * Returns the current value displayed in the counter badge. Linux and macOS only.\n *\n * @returns The badge count.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBadgeCount(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBadgeCount" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getCurrentActivityType:member(1)", "docComment": "/**\n * Returns the type of the currently running activity. macOS only.\n *\n * @returns The current activity type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCurrentActivityType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCurrentActivityType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getFileIcon:member(1)", "docComment": "/**\n * Fetches a path's associated icon.\n *\n * @param path - The path whose icon to fetch.\n *\n * @param options - Options controlling the icon size.\n *\n * @returns A promise resolved with the icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFileIcon(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronFileIconOptions", "canonicalReference": "obsidian-typings!ElectronFileIconOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getFileIcon" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getGPUFeatureStatus:member(1)", "docComment": "/**\n * Returns the Graphics Feature Status from `chrome://gpu/`. Only usable after the `gpu-info-update` event is emitted.\n *\n * @returns The GPU feature status.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGPUFeatureStatus(): " }, { "kind": "Reference", "text": "ElectronGPUFeatureStatus", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getGPUFeatureStatus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getGPUInfo:member(1)", "docComment": "/**\n * Returns GPU information as in Chromium's GPUInfo object.\n *\n * @param infoType - The level of detail to return.\n *\n * @returns A promise resolved with the GPU information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGPUInfo(infoType: " }, { "kind": "Content", "text": "'basic' | 'complete'" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "infoType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getGPUInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getJumpListSettings:member(1)", "docComment": "/**\n * Returns the current settings of the Jump List. Windows only.\n *\n * @returns The Jump List settings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getJumpListSettings(): " }, { "kind": "Reference", "text": "ElectronJumpListSettings", "canonicalReference": "obsidian-typings!ElectronJumpListSettings:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getJumpListSettings" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getLocale:member(1)", "docComment": "/**\n * Returns the current application locale, fetched using Chromium's `l10n_util` library.\n *\n * @returns The locale string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLocale(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLocale" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getLocaleCountryCode:member(1)", "docComment": "/**\n * Returns the operating system's locale two-letter ISO 3166 country code.\n *\n * @returns The country code, or an empty string when it cannot be detected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLocaleCountryCode(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLocaleCountryCode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getLoginItemSettings:member(1)", "docComment": "/**\n * Returns the app's login item settings. macOS and Windows only.\n *\n * @param options - Options used to compare against the current login item settings.\n *\n * @returns The login item settings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLoginItemSettings(options?: " }, { "kind": "Reference", "text": "ElectronLoginItemSettingsOptions", "canonicalReference": "obsidian-typings!ElectronLoginItemSettingsOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronLoginItemSettings", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getLoginItemSettings" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getName:member(1)", "docComment": "/**\n * Returns the current application's name, from the application's `package.json` file.\n *\n * @returns The application name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getName(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getName" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getPath:member(1)", "docComment": "/**\n * Returns a path to a special directory or file associated with `name`.\n *\n * @param name - The name of the special path to retrieve.\n *\n * @returns The full path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPath(name: " }, { "kind": "Content", "text": "'appData' | 'cache' | 'crashDumps' | 'desktop' | 'documents' | 'downloads' | 'exe' | 'home' | 'logs' | 'module' | 'music' | 'pictures' | 'recent' | 'temp' | 'userData' | 'videos'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getPreferredSystemLanguages:member(1)", "docComment": "/**\n * Returns the user's preferred system languages, most preferred first, as BCP 47 language tags.\n *\n * @returns The preferred system languages.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPreferredSystemLanguages(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPreferredSystemLanguages" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getSystemLocale:member(1)", "docComment": "/**\n * Returns the system's current locale as a BCP 47 language tag.\n *\n * @returns The system locale.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSystemLocale(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSystemLocale" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#getVersion:member(1)", "docComment": "/**\n * Returns the version of the loaded application.\n *\n * @returns The version string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getVersion(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getVersion" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#hasSingleInstanceLock:member(1)", "docComment": "/**\n * Returns whether this instance of the app is currently holding the single instance lock.\n *\n * @returns Whether this instance holds the single instance lock.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasSingleInstanceLock(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hasSingleInstanceLock" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#hide:member(1)", "docComment": "/**\n * Hides all application windows without minimizing them. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hide(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hide" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#importCertificate:member(1)", "docComment": "/**\n * Imports the certificate in pkcs12 format into the platform certificate store. Linux only.\n *\n * @param options - The certificate import options.\n *\n * @param callback - Called with the result of the import operation (`0` indicates success).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "importCertificate(options: " }, { "kind": "Reference", "text": "ElectronImportCertificateOptions", "canonicalReference": "obsidian-typings!ElectronImportCertificateOptions:interface" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(result: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "importCertificate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#invalidateCurrentActivity:member(1)", "docComment": "/**\n * Invalidates the current Handoff user activity. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "invalidateCurrentActivity(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "invalidateCurrentActivity" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#isAccessibilitySupportEnabled:member(1)", "docComment": "/**\n * Returns whether Chrome's accessibility support is enabled. macOS and Windows only.\n *\n * @returns Whether accessibility support is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAccessibilitySupportEnabled(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isAccessibilitySupportEnabled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#isDefaultProtocolClient:member(1)", "docComment": "/**\n * Returns whether the current executable is the default handler for a protocol.\n *\n * @param protocol - The protocol name, without the `://`.\n *\n * @param path - The executable path to compare against.\n *\n * @param args - The arguments to compare against.\n *\n * @returns Whether the current executable is the default handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDefaultProtocolClient(protocol: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", args?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "protocol", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "isDefaultProtocolClient" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#isEmojiPanelSupported:member(1)", "docComment": "/**\n * Returns whether the current OS version allows for native emoji pickers.\n *\n * @returns Whether native emoji pickers are supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEmojiPanelSupported(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isEmojiPanelSupported" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#isHidden:member(1)", "docComment": "/**\n * Returns whether the application is currently hidden. macOS only.\n *\n * @returns Whether the app is hidden.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isHidden(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isHidden" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#isInApplicationsFolder:member(1)", "docComment": "/**\n * Returns whether the application is currently running from the system's Application folder. macOS only.\n *\n * @returns Whether the app is in the Applications folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isInApplicationsFolder(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isInApplicationsFolder" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#isPackaged:member", "docComment": "/**\n * Whether the app is packaged. Can be used to distinguish development and production environments.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly isPackaged: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "isPackaged", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#isReady:member(1)", "docComment": "/**\n * Returns whether Electron has finished initializing.\n *\n * @returns Whether the app is ready.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isReady(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isReady" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#isSecureKeyboardEntryEnabled:member(1)", "docComment": "/**\n * Returns whether Secure Keyboard Entry is enabled. macOS only.\n *\n * @returns Whether Secure Keyboard Entry is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isSecureKeyboardEntryEnabled(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isSecureKeyboardEntryEnabled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#isUnityRunning:member(1)", "docComment": "/**\n * Returns whether the current desktop environment is the Unity launcher. Linux only.\n *\n * @returns Whether Unity is running.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isUnityRunning(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isUnityRunning" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#moveToApplicationsFolder:member(1)", "docComment": "/**\n * Moves the current app to the Applications folder. If successful, the app quits and relaunches. macOS only.\n *\n * @param options - Options including a conflict handler.\n *\n * @returns Whether the move was successful.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveToApplicationsFolder(options?: " }, { "kind": "Reference", "text": "ElectronMoveToApplicationsFolderOptions", "canonicalReference": "obsidian-typings!ElectronMoveToApplicationsFolderOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "moveToApplicationsFolder" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#name:member", "docComment": "/**\n * The current application's name, from the application's `package.json` file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(1)", "docComment": "/**\n * Registers a listener for the `accessibility-support-changed` event.\n *\n * Emitted when Chrome's accessibility support changes. macOS and Windows only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'accessibility-support-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", accessibilitySupportEnabled: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(10)", "docComment": "/**\n * Registers a listener for the `continue-activity` event.\n *\n * Emitted during Handoff when an activity from a different device wants to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'continue-activity'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown, details: " }, { "kind": "Reference", "text": "ElectronContinueActivityDetails", "canonicalReference": "obsidian-typings!ElectronContinueActivityDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(11)", "docComment": "/**\n * Registers a listener for the `continue-activity-error` event.\n *\n * Emitted during Handoff when an activity from a different device fails to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'continue-activity-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, error: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(12)", "docComment": "/**\n * Registers a listener for the `did-become-active` event.\n *\n * Emitted every time the app becomes active. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-become-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(13)", "docComment": "/**\n * Registers a listener for the `first-instance-ack` event.\n *\n * Emitted in the second instance during `requestSingleInstanceLock` when the first instance calls the `ackCallback`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'first-instance-ack'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", additionalData: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(14)", "docComment": "/**\n * Registers a listener for the `gpu-info-update` event.\n *\n * Emitted whenever there is a GPU info update.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'gpu-info-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(15)", "docComment": "/**\n * Registers a listener for the `gpu-process-crashed` event.\n *\n * Emitted when the GPU process crashes or is killed.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'gpu-process-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(16)", "docComment": "/**\n * Registers a listener for the `login` event.\n *\n * Emitted when `webContents` wants to do basic auth.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", authenticationResponseDetails: " }, { "kind": "Reference", "text": "ElectronAuthenticationResponseDetails", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface" }, { "kind": "Content", "text": ", authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(17)", "docComment": "/**\n * Registers a listener for the `new-window-for-tab` event.\n *\n * Emitted when the user clicks the native macOS new tab button. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'new-window-for-tab'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(18)", "docComment": "/**\n * Registers a listener for the `open-file` event.\n *\n * Emitted when the user wants to open a file with the application. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'open-file'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", path: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(19)", "docComment": "/**\n * Registers a listener for the `open-url` event.\n *\n * Emitted when the user wants to open a URL with the application. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'open-url'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(2)", "docComment": "/**\n * Registers a listener for the `activate` event.\n *\n * Emitted when the application is activated. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'activate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", hasVisibleWindows: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(20)", "docComment": "/**\n * Registers a listener for the `quit` event.\n *\n * Emitted when the application is quitting.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", exitCode: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(21)", "docComment": "/**\n * Registers a listener for the `ready` event.\n *\n * Emitted once, when Electron has finished initializing.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", launchInfo: " }, { "kind": "Reference", "text": "ElectronNotificationResponse", "canonicalReference": "obsidian-typings!ElectronNotificationResponse:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(22)", "docComment": "/**\n * Registers a listener for the `render-process-gone` event.\n *\n * Emitted when the renderer process unexpectedly disappears.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'render-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRenderProcessGoneDetails", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(23)", "docComment": "/**\n * Registers a listener for the `renderer-process-crashed` event.\n *\n * Emitted when the renderer process of `webContents` crashes or is killed.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'renderer-process-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(24)", "docComment": "/**\n * Registers a listener for the `second-instance` event.\n *\n * Emitted inside the primary instance when a second instance is executed and calls `requestSingleInstanceLock`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'second-instance'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", argv: string[], workingDirectory: string, additionalData: unknown, ackCallback: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(25)", "docComment": "/**\n * Registers a listener for the `select-client-certificate` event.\n *\n * Emitted when a client certificate is requested.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'select-client-certificate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", url: string, certificateList: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": "[], callback: (certificate?: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(26)", "docComment": "/**\n * Registers a listener for the `session-created` event.\n *\n * Emitted when Electron has created a new `session`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'session-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(session: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(27)", "docComment": "/**\n * Registers a listener for the `update-activity-state` event.\n *\n * Emitted when Handoff is about to be resumed on another device. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'update-activity-state'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(28)", "docComment": "/**\n * Registers a listener for the `web-contents-created` event.\n *\n * Emitted when a new `webContents` is created.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'web-contents-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(29)", "docComment": "/**\n * Registers a listener for the `will-continue-activity` event.\n *\n * Emitted during Handoff before an activity from a different device wants to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-continue-activity'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(3)", "docComment": "/**\n * Registers a listener for the `activity-was-continued` event.\n *\n * Emitted during Handoff after an activity from this device was successfully resumed on another one. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'activity-was-continued'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(30)", "docComment": "/**\n * Registers a listener for the `will-finish-launching` event.\n *\n * Emitted when the application has finished basic startup.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-finish-launching'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(31)", "docComment": "/**\n * Registers a listener for the `will-quit` event.\n *\n * Emitted when all windows have been closed and the application will quit.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(32)", "docComment": "/**\n * Registers a listener for the `window-all-closed` event.\n *\n * Emitted when all windows have been closed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'window-all-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(4)", "docComment": "/**\n * Registers a listener for the `before-quit` event.\n *\n * Emitted before the application starts closing its windows.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'before-quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(5)", "docComment": "/**\n * Registers a listener for the `browser-window-blur` event.\n *\n * Emitted when a browserWindow gets blurred.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'browser-window-blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(6)", "docComment": "/**\n * Registers a listener for the `browser-window-created` event.\n *\n * Emitted when a new browserWindow is created.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'browser-window-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(7)", "docComment": "/**\n * Registers a listener for the `browser-window-focus` event.\n *\n * Emitted when a browserWindow gets focused.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'browser-window-focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(8)", "docComment": "/**\n * Registers a listener for the `certificate-error` event.\n *\n * Emitted when failed to verify the certificate for a URL.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'certificate-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", url: string, error: string, certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ", callback: (isTrusted: boolean) => void, isMainFrame: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#on:member(9)", "docComment": "/**\n * Registers a listener for the `child-process-gone` event.\n *\n * Emitted when the child process unexpectedly disappears.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'child-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronDetails", "canonicalReference": "obsidian-typings!ElectronDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `accessibility-support-changed` event.\n *\n * Emitted when Chrome's accessibility support changes. macOS and Windows only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'accessibility-support-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", accessibilitySupportEnabled: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(10)", "docComment": "/**\n * Registers a one-time listener for the `continue-activity` event.\n *\n * Emitted during Handoff when an activity from a different device wants to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'continue-activity'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown, details: " }, { "kind": "Reference", "text": "ElectronContinueActivityDetails", "canonicalReference": "obsidian-typings!ElectronContinueActivityDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(11)", "docComment": "/**\n * Registers a one-time listener for the `continue-activity-error` event.\n *\n * Emitted during Handoff when an activity from a different device fails to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'continue-activity-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, error: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(12)", "docComment": "/**\n * Registers a one-time listener for the `did-become-active` event.\n *\n * Emitted every time the app becomes active. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-become-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(13)", "docComment": "/**\n * Registers a one-time listener for the `first-instance-ack` event.\n *\n * Emitted in the second instance during `requestSingleInstanceLock` when the first instance calls the `ackCallback`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'first-instance-ack'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", additionalData: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(14)", "docComment": "/**\n * Registers a one-time listener for the `gpu-info-update` event.\n *\n * Emitted whenever there is a GPU info update.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'gpu-info-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(15)", "docComment": "/**\n * Registers a one-time listener for the `gpu-process-crashed` event.\n *\n * Emitted when the GPU process crashes or is killed.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'gpu-process-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(16)", "docComment": "/**\n * Registers a one-time listener for the `login` event.\n *\n * Emitted when `webContents` wants to do basic auth.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", authenticationResponseDetails: " }, { "kind": "Reference", "text": "ElectronAuthenticationResponseDetails", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface" }, { "kind": "Content", "text": ", authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(17)", "docComment": "/**\n * Registers a one-time listener for the `new-window-for-tab` event.\n *\n * Emitted when the user clicks the native macOS new tab button. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'new-window-for-tab'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(18)", "docComment": "/**\n * Registers a one-time listener for the `open-file` event.\n *\n * Emitted when the user wants to open a file with the application. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'open-file'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", path: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(19)", "docComment": "/**\n * Registers a one-time listener for the `open-url` event.\n *\n * Emitted when the user wants to open a URL with the application. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'open-url'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `activate` event.\n *\n * Emitted when the application is activated. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'activate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", hasVisibleWindows: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(20)", "docComment": "/**\n * Registers a one-time listener for the `quit` event.\n *\n * Emitted when the application is quitting.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", exitCode: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(21)", "docComment": "/**\n * Registers a one-time listener for the `ready` event.\n *\n * Emitted once, when Electron has finished initializing.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", launchInfo: " }, { "kind": "Reference", "text": "ElectronNotificationResponse", "canonicalReference": "obsidian-typings!ElectronNotificationResponse:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(22)", "docComment": "/**\n * Registers a one-time listener for the `render-process-gone` event.\n *\n * Emitted when the renderer process unexpectedly disappears.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'render-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRenderProcessGoneDetails", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(23)", "docComment": "/**\n * Registers a one-time listener for the `renderer-process-crashed` event.\n *\n * Emitted when the renderer process of `webContents` crashes or is killed.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'renderer-process-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(24)", "docComment": "/**\n * Registers a one-time listener for the `second-instance` event.\n *\n * Emitted inside the primary instance when a second instance is executed and calls `requestSingleInstanceLock`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'second-instance'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", argv: string[], workingDirectory: string, additionalData: unknown, ackCallback: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(25)", "docComment": "/**\n * Registers a one-time listener for the `select-client-certificate` event.\n *\n * Emitted when a client certificate is requested.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'select-client-certificate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", url: string, certificateList: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": "[], callback: (certificate?: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(26)", "docComment": "/**\n * Registers a one-time listener for the `session-created` event.\n *\n * Emitted when Electron has created a new `session`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'session-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(session: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(27)", "docComment": "/**\n * Registers a one-time listener for the `update-activity-state` event.\n *\n * Emitted when Handoff is about to be resumed on another device. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'update-activity-state'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(28)", "docComment": "/**\n * Registers a one-time listener for the `web-contents-created` event.\n *\n * Emitted when a new `webContents` is created.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'web-contents-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(29)", "docComment": "/**\n * Registers a one-time listener for the `will-continue-activity` event.\n *\n * Emitted during Handoff before an activity from a different device wants to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-continue-activity'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(3)", "docComment": "/**\n * Registers a one-time listener for the `activity-was-continued` event.\n *\n * Emitted during Handoff after an activity from this device was successfully resumed on another one. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'activity-was-continued'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(30)", "docComment": "/**\n * Registers a one-time listener for the `will-finish-launching` event.\n *\n * Emitted when the application has finished basic startup.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-finish-launching'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(31)", "docComment": "/**\n * Registers a one-time listener for the `will-quit` event.\n *\n * Emitted when all windows have been closed and the application will quit.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(32)", "docComment": "/**\n * Registers a one-time listener for the `window-all-closed` event.\n *\n * Emitted when all windows have been closed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'window-all-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(4)", "docComment": "/**\n * Registers a one-time listener for the `before-quit` event.\n *\n * Emitted before the application starts closing its windows.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'before-quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(5)", "docComment": "/**\n * Registers a one-time listener for the `browser-window-blur` event.\n *\n * Emitted when a browserWindow gets blurred.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'browser-window-blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(6)", "docComment": "/**\n * Registers a one-time listener for the `browser-window-created` event.\n *\n * Emitted when a new browserWindow is created.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'browser-window-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(7)", "docComment": "/**\n * Registers a one-time listener for the `browser-window-focus` event.\n *\n * Emitted when a browserWindow gets focused.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'browser-window-focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(8)", "docComment": "/**\n * Registers a one-time listener for the `certificate-error` event.\n *\n * Emitted when failed to verify the certificate for a URL.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'certificate-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", url: string, error: string, certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ", callback: (isTrusted: boolean) => void, isMainFrame: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#once:member(9)", "docComment": "/**\n * Registers a one-time listener for the `child-process-gone` event.\n *\n * Emitted when the child process unexpectedly disappears.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'child-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronDetails", "canonicalReference": "obsidian-typings!ElectronDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#quit:member(1)", "docComment": "/**\n * Tries to close all windows. The `before-quit` event is emitted first; if all windows are successfully closed, the `will-quit` event is emitted and by default the application terminates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "quit(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "quit" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#relaunch:member(1)", "docComment": "/**\n * Relaunches the app when the current instance exits.\n *\n * @param options - Options controlling the relaunched instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "relaunch(options?: " }, { "kind": "Reference", "text": "ElectronRelaunchOptions", "canonicalReference": "obsidian-typings!ElectronRelaunchOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "relaunch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#releaseSingleInstanceLock:member(1)", "docComment": "/**\n * Releases all locks that were created by `requestSingleInstanceLock`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "releaseSingleInstanceLock(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "releaseSingleInstanceLock" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeAsDefaultProtocolClient:member(1)", "docComment": "/**\n * Removes the current executable as the default handler for a protocol. macOS and Windows only.\n *\n * @param protocol - The protocol name, without the `://`.\n *\n * @param path - The executable path to compare against.\n *\n * @param args - The arguments to compare against.\n *\n * @returns Whether the call succeeded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeAsDefaultProtocolClient(protocol: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", args?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "protocol", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "removeAsDefaultProtocolClient" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(1)", "docComment": "/**\n * Removes a previously added listener for the `accessibility-support-changed` event.\n *\n * Emitted when Chrome's accessibility support changes. macOS and Windows only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'accessibility-support-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", accessibilitySupportEnabled: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(10)", "docComment": "/**\n * Removes a previously added listener for the `continue-activity` event.\n *\n * Emitted during Handoff when an activity from a different device wants to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'continue-activity'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown, details: " }, { "kind": "Reference", "text": "ElectronContinueActivityDetails", "canonicalReference": "obsidian-typings!ElectronContinueActivityDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(11)", "docComment": "/**\n * Removes a previously added listener for the `continue-activity-error` event.\n *\n * Emitted during Handoff when an activity from a different device fails to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'continue-activity-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, error: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(12)", "docComment": "/**\n * Removes a previously added listener for the `did-become-active` event.\n *\n * Emitted every time the app becomes active. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-become-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(13)", "docComment": "/**\n * Removes a previously added listener for the `first-instance-ack` event.\n *\n * Emitted in the second instance during `requestSingleInstanceLock` when the first instance calls the `ackCallback`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'first-instance-ack'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", additionalData: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(14)", "docComment": "/**\n * Removes a previously added listener for the `gpu-info-update` event.\n *\n * Emitted whenever there is a GPU info update.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'gpu-info-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(15)", "docComment": "/**\n * Removes a previously added listener for the `gpu-process-crashed` event.\n *\n * Emitted when the GPU process crashes or is killed.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'gpu-process-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(16)", "docComment": "/**\n * Removes a previously added listener for the `login` event.\n *\n * Emitted when `webContents` wants to do basic auth.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", authenticationResponseDetails: " }, { "kind": "Reference", "text": "ElectronAuthenticationResponseDetails", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface" }, { "kind": "Content", "text": ", authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(17)", "docComment": "/**\n * Removes a previously added listener for the `new-window-for-tab` event.\n *\n * Emitted when the user clicks the native macOS new tab button. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'new-window-for-tab'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(18)", "docComment": "/**\n * Removes a previously added listener for the `open-file` event.\n *\n * Emitted when the user wants to open a file with the application. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'open-file'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", path: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(19)", "docComment": "/**\n * Removes a previously added listener for the `open-url` event.\n *\n * Emitted when the user wants to open a URL with the application. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'open-url'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(2)", "docComment": "/**\n * Removes a previously added listener for the `activate` event.\n *\n * Emitted when the application is activated. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'activate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", hasVisibleWindows: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(20)", "docComment": "/**\n * Removes a previously added listener for the `quit` event.\n *\n * Emitted when the application is quitting.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", exitCode: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(21)", "docComment": "/**\n * Removes a previously added listener for the `ready` event.\n *\n * Emitted once, when Electron has finished initializing.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", launchInfo: " }, { "kind": "Reference", "text": "ElectronNotificationResponse", "canonicalReference": "obsidian-typings!ElectronNotificationResponse:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(22)", "docComment": "/**\n * Removes a previously added listener for the `render-process-gone` event.\n *\n * Emitted when the renderer process unexpectedly disappears.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'render-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRenderProcessGoneDetails", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(23)", "docComment": "/**\n * Removes a previously added listener for the `renderer-process-crashed` event.\n *\n * Emitted when the renderer process of `webContents` crashes or is killed.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'renderer-process-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(24)", "docComment": "/**\n * Removes a previously added listener for the `second-instance` event.\n *\n * Emitted inside the primary instance when a second instance is executed and calls `requestSingleInstanceLock`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'second-instance'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", argv: string[], workingDirectory: string, additionalData: unknown, ackCallback: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(25)", "docComment": "/**\n * Removes a previously added listener for the `select-client-certificate` event.\n *\n * Emitted when a client certificate is requested.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'select-client-certificate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", url: string, certificateList: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": "[], callback: (certificate?: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(26)", "docComment": "/**\n * Removes a previously added listener for the `session-created` event.\n *\n * Emitted when Electron has created a new `session`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'session-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(session: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(27)", "docComment": "/**\n * Removes a previously added listener for the `update-activity-state` event.\n *\n * Emitted when Handoff is about to be resumed on another device. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'update-activity-state'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(28)", "docComment": "/**\n * Removes a previously added listener for the `web-contents-created` event.\n *\n * Emitted when a new `webContents` is created.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'web-contents-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(29)", "docComment": "/**\n * Removes a previously added listener for the `will-continue-activity` event.\n *\n * Emitted during Handoff before an activity from a different device wants to be resumed. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-continue-activity'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(3)", "docComment": "/**\n * Removes a previously added listener for the `activity-was-continued` event.\n *\n * Emitted during Handoff after an activity from this device was successfully resumed on another one. macOS only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'activity-was-continued'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, userInfo: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(30)", "docComment": "/**\n * Removes a previously added listener for the `will-finish-launching` event.\n *\n * Emitted when the application has finished basic startup.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-finish-launching'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(31)", "docComment": "/**\n * Removes a previously added listener for the `will-quit` event.\n *\n * Emitted when all windows have been closed and the application will quit.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(32)", "docComment": "/**\n * Removes a previously added listener for the `window-all-closed` event.\n *\n * Emitted when all windows have been closed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'window-all-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(4)", "docComment": "/**\n * Removes a previously added listener for the `before-quit` event.\n *\n * Emitted before the application starts closing its windows.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'before-quit'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(5)", "docComment": "/**\n * Removes a previously added listener for the `browser-window-blur` event.\n *\n * Emitted when a browserWindow gets blurred.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'browser-window-blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(6)", "docComment": "/**\n * Removes a previously added listener for the `browser-window-created` event.\n *\n * Emitted when a new browserWindow is created.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'browser-window-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(7)", "docComment": "/**\n * Removes a previously added listener for the `browser-window-focus` event.\n *\n * Emitted when a browserWindow gets focused.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'browser-window-focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(8)", "docComment": "/**\n * Removes a previously added listener for the `certificate-error` event.\n *\n * Emitted when failed to verify the certificate for a URL.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'certificate-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", url: string, error: string, certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ", callback: (isTrusted: boolean) => void, isMainFrame: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#removeListener:member(9)", "docComment": "/**\n * Removes a previously added listener for the `child-process-gone` event.\n *\n * Emitted when the child process unexpectedly disappears.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronApp` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'child-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronDetails", "canonicalReference": "obsidian-typings!ElectronDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#requestSingleInstanceLock:member(1)", "docComment": "/**\n * Requests the single instance lock. Returns whether this instance obtained the lock and should continue loading.\n *\n * @param additionalData - A JSON object to send to the first instance.\n *\n * @returns Whether this process is the primary instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestSingleInstanceLock(additionalData?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "additionalData", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true } ], "name": "requestSingleInstanceLock" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#resignCurrentActivity:member(1)", "docComment": "/**\n * Marks the current Handoff user activity as inactive without invalidating it. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resignCurrentActivity(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "resignCurrentActivity" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#runningUnderARM64Translation:member", "docComment": "/**\n * Whether the app is currently running under an ARM64 translator (Rosetta or Windows WOW). macOS and Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly runningUnderARM64Translation: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "runningUnderARM64Translation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#runningUnderRosettaTranslation:member", "docComment": "/**\n * Whether the app is currently running under the Rosetta Translator Environment. macOS only.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly runningUnderRosettaTranslation: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "runningUnderRosettaTranslation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setAboutPanelOptions:member(1)", "docComment": "/**\n * Sets the about panel options.\n *\n * @param options - The about panel options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAboutPanelOptions(options: " }, { "kind": "Reference", "text": "ElectronAboutPanelOptionsOptions", "canonicalReference": "obsidian-typings!ElectronAboutPanelOptionsOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setAboutPanelOptions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setAccessibilitySupportEnabled:member(1)", "docComment": "/**\n * Manually enables or disables Chrome's accessibility support. Must be called after the `ready` event. macOS and Windows only.\n *\n * @param enabled - Whether to enable accessibility support.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAccessibilitySupportEnabled(enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "enabled", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setAccessibilitySupportEnabled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setActivationPolicy:member(1)", "docComment": "/**\n * Sets the activation policy for the app. macOS only.\n *\n * @param policy - The activation policy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setActivationPolicy(policy: " }, { "kind": "Content", "text": "'accessory' | 'prohibited' | 'regular'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "policy", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setActivationPolicy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setAppLogsPath:member(1)", "docComment": "/**\n * Sets or creates a directory for the app's logs.\n *\n * @param path - The custom log directory path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAppLogsPath(path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "setAppLogsPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setAppUserModelId:member(1)", "docComment": "/**\n * Changes the Application User Model ID to `id`. Windows only.\n *\n * @param id - The Application User Model ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAppUserModelId(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setAppUserModelId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setAsDefaultProtocolClient:member(1)", "docComment": "/**\n * Sets the current executable as the default handler for a protocol.\n *\n * @param protocol - The protocol name, without the `://`.\n *\n * @param path - The executable path.\n *\n * @param args - The arguments.\n *\n * @returns Whether the call succeeded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAsDefaultProtocolClient(protocol: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", args?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "protocol", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "setAsDefaultProtocolClient" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setBadgeCount:member(1)", "docComment": "/**\n * Sets the counter badge for the current app. Setting the count to `0` hides the badge. Linux and macOS only.\n *\n * @param count - The badge count.\n *\n * @returns Whether the call succeeded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBadgeCount(count?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "count", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "setBadgeCount" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setJumpList:member(1)", "docComment": "/**\n * Sets or removes a custom Jump List for the application. Windows only.\n *\n * @param categories - The Jump List categories, or `null` to restore the standard Jump List.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setJumpList(categories: " }, { "kind": "Reference", "text": "ElectronJumpListCategory", "canonicalReference": "obsidian-typings!ElectronJumpListCategory:interface" }, { "kind": "Content", "text": "[] | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "categories", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "setJumpList" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setLoginItemSettings:member(1)", "docComment": "/**\n * Sets the app's login item settings. macOS and Windows only.\n *\n * @param settings - The login item settings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setLoginItemSettings(settings: " }, { "kind": "Reference", "text": "ElectronSettings", "canonicalReference": "obsidian-typings!ElectronSettings:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "settings", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setLoginItemSettings" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setName:member(1)", "docComment": "/**\n * Overrides the current application's name.\n *\n * @param name - The new application name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setName(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setName" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setPath:member(1)", "docComment": "/**\n * Overrides the path to a special directory or file associated with `name`.\n *\n * @param name - The name of the special path to override.\n *\n * @param path - The new path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPath(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setSecureKeyboardEntryEnabled:member(1)", "docComment": "/**\n * Sets whether Secure Keyboard Entry is enabled in the application. macOS only.\n *\n * @param enabled - Whether to enable Secure Keyboard Entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSecureKeyboardEntryEnabled(enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "enabled", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSecureKeyboardEntryEnabled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setUserActivity:member(1)", "docComment": "/**\n * Creates an `NSUserActivity` and sets it as the current activity. macOS only.\n *\n * @param type - Uniquely identifies the activity.\n *\n * @param userInfo - App-specific state to store for use by another device.\n *\n * @param webpageURL - The webpage to load in a browser if no suitable app is installed on the resuming device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUserActivity(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userInfo: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", webpageURL?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userInfo", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "webpageURL", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "setUserActivity" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#setUserTasks:member(1)", "docComment": "/**\n * Adds `tasks` to the Tasks category of the Jump List. Windows only.\n *\n * @param tasks - The tasks to add.\n *\n * @returns Whether the call succeeded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUserTasks(tasks: " }, { "kind": "Reference", "text": "ElectronTask", "canonicalReference": "obsidian-typings!ElectronTask:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tasks", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "setUserTasks" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#show:member(1)", "docComment": "/**\n * Shows application windows after they were hidden. Does not automatically focus them. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "show(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "show" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#showAboutPanel:member(1)", "docComment": "/**\n * Shows the app's about panel options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showAboutPanel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showAboutPanel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#showEmojiPanel:member(1)", "docComment": "/**\n * Shows the platform's native emoji picker. macOS and Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showEmojiPanel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showEmojiPanel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#startAccessingSecurityScopedResource:member(1)", "docComment": "/**\n * Starts accessing a security scoped resource. Must be balanced by calling the returned function once finished. macOS (MAS) only.\n *\n * @param bookmarkData - The base64-encoded security scoped bookmark data.\n *\n * @returns A function that stops accessing the security scoped resource.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startAccessingSecurityScopedResource(bookmarkData: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "bookmarkData", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "startAccessingSecurityScopedResource" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#updateCurrentActivity:member(1)", "docComment": "/**\n * Updates the current activity if its type matches `type`, merging the entries from `userInfo`. macOS only.\n *\n * @param type - Uniquely identifies the activity.\n *\n * @param userInfo - App-specific state to merge into the current activity.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateCurrentActivity(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userInfo: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userInfo", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "updateCurrentActivity" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApp#userAgentFallback:member", "docComment": "/**\n * The user agent string Electron uses as a global fallback.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userAgentFallback: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "userAgentFallback", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronApp#whenReady:member(1)", "docComment": "/**\n * Returns a promise fulfilled when Electron is initialized.\n *\n * @returns A promise resolved when the app is ready.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "whenReady(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "whenReady" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronAppDetailsOptions:interface", "docComment": "/**\n * Options for the window's taskbar button (Windows only).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronAppDetailsOptions " } ], "fileUrlPath": "src/electron/internals/ElectronAppDetailsOptions.d.ts", "releaseTag": "Public", "name": "ElectronAppDetailsOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAppDetailsOptions#appIconIndex:member", "docComment": "/**\n * Index of the icon in `appIconPath`. Ignored when `appIconPath` is not set.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appIconIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "appIconIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAppDetailsOptions#appIconPath:member", "docComment": "/**\n * Window's Relaunch Icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appIconPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "appIconPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAppDetailsOptions#appId:member", "docComment": "/**\n * Window's App User Model ID. It has to be set, otherwise the other options will have no effect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appId?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "appId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAppDetailsOptions#relaunchCommand:member", "docComment": "/**\n * Window's Relaunch Command.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "relaunchCommand?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "relaunchCommand", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAppDetailsOptions#relaunchDisplayName:member", "docComment": "/**\n * Window's Relaunch Display Name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "relaunchDisplayName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "relaunchDisplayName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronApplicationInfoForProtocolReturnValue:interface", "docComment": "/**\n * Information about the application handling a given protocol.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronApplicationInfoForProtocolReturnValue " } ], "fileUrlPath": "src/electron/internals/ElectronApplicationInfoForProtocolReturnValue.d.ts", "releaseTag": "Public", "name": "ElectronApplicationInfoForProtocolReturnValue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApplicationInfoForProtocolReturnValue#icon:member", "docComment": "/**\n * The display icon of the app handling the protocol.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApplicationInfoForProtocolReturnValue#name:member", "docComment": "/**\n * Display name of the app handling the protocol.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronApplicationInfoForProtocolReturnValue#path:member", "docComment": "/**\n * Installation path of the app handling the protocol.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface", "docComment": "/**\n * Details about an authentication request emitted with the `login` event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronAuthenticationResponseDetails " } ], "fileUrlPath": "src/electron/internals/ElectronAuthenticationResponseDetails.d.ts", "releaseTag": "Public", "name": "ElectronAuthenticationResponseDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails#url:member", "docComment": "/**\n * The URL of the request that triggered the authentication.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface", "docComment": "/**\n * Information about an authentication challenge.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronAuthInfo " } ], "fileUrlPath": "src/electron/internals/ElectronAuthInfo.d.ts", "releaseTag": "Public", "name": "ElectronAuthInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAuthInfo#host:member", "docComment": "/**\n * The host requesting authentication.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "host: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "host", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAuthInfo#isProxy:member", "docComment": "/**\n * Whether the request is for a proxy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isProxy: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isProxy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAuthInfo#port:member", "docComment": "/**\n * The port requesting authentication.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "port: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "port", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAuthInfo#realm:member", "docComment": "/**\n * The authentication realm.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "realm: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "realm", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAuthInfo#scheme:member", "docComment": "/**\n * The authentication scheme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scheme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronAutoResizeOptions:interface", "docComment": "/**\n * Options controlling how a {@link ElectronBrowserView} auto-resizes with its window.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronAutoResizeOptions " } ], "fileUrlPath": "src/electron/internals/ElectronAutoResizeOptions.d.ts", "releaseTag": "Public", "name": "ElectronAutoResizeOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAutoResizeOptions#height:member", "docComment": "/**\n * If `true`, the view's height will grow and shrink together with the window.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAutoResizeOptions#horizontal:member", "docComment": "/**\n * If `true`, the view's x position and width will grow and shrink proportionally with the window.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "horizontal?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "horizontal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAutoResizeOptions#vertical:member", "docComment": "/**\n * If `true`, the view's y position and height will grow and shrink proportionally with the window.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vertical?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "vertical", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronAutoResizeOptions#width:member", "docComment": "/**\n * If `true`, the view's width will grow and shrink together with the window.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronAutoUpdater:interface", "docComment": "/**\n * Enables apps to automatically update themselves.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronAutoUpdater extends " }, { "kind": "Reference", "text": "NodeJS.EventEmitter", "canonicalReference": "!\"\\\"node:events\\\"\".__global.NodeJS.EventEmitter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronAutoUpdater.d.ts", "releaseTag": "Public", "name": "ElectronAutoUpdater", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#addListener:member(1)", "docComment": "/**\n * Registers a listener for the given auto updater event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `AutoUpdater` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'before-quit-for-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#addListener:member(2)", "docComment": "/**\n * Registers a listener for the `checking-for-update` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'checking-for-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#addListener:member(3)", "docComment": "/**\n * Registers a listener for the `error` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#addListener:member(4)", "docComment": "/**\n * Registers a listener for the `update-available` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'update-available'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#addListener:member(5)", "docComment": "/**\n * Registers a listener for the `update-downloaded` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'update-downloaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", releaseNotes: string, releaseName: string, releaseDate: " }, { "kind": "Reference", "text": "Date", "canonicalReference": "!Date:interface" }, { "kind": "Content", "text": ", updateURL: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#addListener:member(6)", "docComment": "/**\n * Registers a listener for the `update-not-available` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'update-not-available'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#checkForUpdates:member(1)", "docComment": "/**\n * Asks the server whether there is an update. You must call `setFeedURL` before using this API.\n *\n * **Note:** If an update is available it will be downloaded automatically. Calling `autoUpdater.checkForUpdates()` twice will download the update two times.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkForUpdates(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "checkForUpdates" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#getFeedURL:member(1)", "docComment": "/**\n * The current update feed URL.\n *\n * @returns The current update feed URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFeedURL(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFeedURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#on:member(1)", "docComment": "/**\n * Registers a listener for the given auto updater event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `AutoUpdater` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'before-quit-for-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#on:member(2)", "docComment": "/**\n * Registers a listener for the `checking-for-update` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'checking-for-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#on:member(3)", "docComment": "/**\n * Registers a listener for the `error` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#on:member(4)", "docComment": "/**\n * Registers a listener for the `update-available` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'update-available'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#on:member(5)", "docComment": "/**\n * Registers a listener for the `update-downloaded` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'update-downloaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", releaseNotes: string, releaseName: string, releaseDate: " }, { "kind": "Reference", "text": "Date", "canonicalReference": "!Date:interface" }, { "kind": "Content", "text": ", updateURL: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#on:member(6)", "docComment": "/**\n * Registers a listener for the `update-not-available` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'update-not-available'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the given auto updater event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `AutoUpdater` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'before-quit-for-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `checking-for-update` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'checking-for-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#once:member(3)", "docComment": "/**\n * Registers a one-time listener for the `error` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#once:member(4)", "docComment": "/**\n * Registers a one-time listener for the `update-available` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'update-available'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#once:member(5)", "docComment": "/**\n * Registers a one-time listener for the `update-downloaded` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'update-downloaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", releaseNotes: string, releaseName: string, releaseDate: " }, { "kind": "Reference", "text": "Date", "canonicalReference": "!Date:interface" }, { "kind": "Content", "text": ", updateURL: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#once:member(6)", "docComment": "/**\n * Registers a one-time listener for the `update-not-available` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'update-not-available'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#quitAndInstall:member(1)", "docComment": "/**\n * Restarts the app and installs the update after it has been downloaded. It should only be called after `update-downloaded` has been emitted.\n *\n * Under the hood calling `autoUpdater.quitAndInstall()` will close all application windows first, and automatically call `app.quit()` after all windows have been closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "quitAndInstall(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "quitAndInstall" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#removeListener:member(1)", "docComment": "/**\n * Removes the given listener for the given auto updater event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `AutoUpdater` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'before-quit-for-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#removeListener:member(2)", "docComment": "/**\n * Removes the listener for the `checking-for-update` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'checking-for-update'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#removeListener:member(3)", "docComment": "/**\n * Removes the listener for the `error` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#removeListener:member(4)", "docComment": "/**\n * Removes the listener for the `update-available` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'update-available'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#removeListener:member(5)", "docComment": "/**\n * Removes the listener for the `update-downloaded` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'update-downloaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", releaseNotes: string, releaseName: string, releaseDate: " }, { "kind": "Reference", "text": "Date", "canonicalReference": "!Date:interface" }, { "kind": "Content", "text": ", updateURL: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#removeListener:member(6)", "docComment": "/**\n * Removes the listener for the `update-not-available` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'update-not-available'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronAutoUpdater#setFeedURL:member(1)", "docComment": "/**\n * Sets the `url` and initialize the auto updater.\n *\n * @param options - The feed URL options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFeedURL(options: " }, { "kind": "Reference", "text": "ElectronFeedURLOptions", "canonicalReference": "obsidian-typings!ElectronFeedURLOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setFeedURL" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronBeforeSendResponse:interface", "docComment": "/**\n * Response object returned by an `onBeforeSendHeaders` web-request listener callback.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronBeforeSendResponse " } ], "fileUrlPath": "src/electron/internals/ElectronBeforeSendResponse.d.ts", "releaseTag": "Public", "name": "ElectronBeforeSendResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBeforeSendResponse#cancel:member", "docComment": "/**\n * Whether to cancel the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cancel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBeforeSendResponse#requestHeaders:member", "docComment": "/**\n * When provided, request will be made with these headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestHeaders?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string | string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "requestHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronBluetoothDevice:interface", "docComment": "/**\n * A Bluetooth device available for selection.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronBluetoothDevice " } ], "fileUrlPath": "src/electron/internals/ElectronBluetoothDevice.d.ts", "releaseTag": "Public", "name": "ElectronBluetoothDevice", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBluetoothDevice#deviceId:member", "docComment": "/**\n * The unique identifier of the device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deviceId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBluetoothDevice#deviceName:member", "docComment": "/**\n * The human-readable name of the device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deviceName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingHandlerHandlerDetails:interface", "docComment": "/**\n * Details passed to the {@link Session.setBluetoothPairingHandler} handler describing a Bluetooth pairing request.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronBluetoothPairingHandlerHandlerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronBluetoothPairingHandlerHandlerDetails.d.ts", "releaseTag": "Public", "name": "ElectronBluetoothPairingHandlerHandlerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingHandlerHandlerDetails#deviceId:member", "docComment": "/**\n * The identifier of the device requesting pairing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deviceId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingHandlerHandlerDetails#frame:member", "docComment": "/**\n * The frame that initiated the pairing request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingHandlerHandlerDetails#pairingKind:member", "docComment": "/**\n * The type of pairing prompt being requested.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pairingKind: " }, { "kind": "Content", "text": "'confirm' | 'confirmPin' | 'providePin'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pairingKind", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingHandlerHandlerDetails#pin:member", "docComment": "/**\n * The pin value to verify when `pairingKind` is `confirmPin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingResponse:interface", "docComment": "/**\n * Response returned to the {@link Session.setBluetoothPairingHandler} callback to resolve a Bluetooth pairing request.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronBluetoothPairingResponse " } ], "fileUrlPath": "src/electron/internals/ElectronBluetoothPairingResponse.d.ts", "releaseTag": "Public", "name": "ElectronBluetoothPairingResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingResponse#confirmed:member", "docComment": "/**\n * Whether the pairing is confirmed. Pass `false` when the dialog is canceled; when `pairingKind` is `providePin`, pass `true` when a value is provided.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "confirmed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "confirmed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingResponse#pin:member", "docComment": "/**\n * When `pairingKind` is `providePin`, the required pin for the Bluetooth device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pin?: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronBrowserView:class", "docComment": "/**\n * Electron BrowserView for embedding additional web content in a {@link ElectronBrowserWindow}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronBrowserView " } ], "fileUrlPath": "src/electron/internals/ElectronBrowserView.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronBrowserView", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronBrowserView:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronBrowserView}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options?: " }, { "kind": "Reference", "text": "ElectronBrowserViewConstructorOptions", "canonicalReference": "obsidian-typings!ElectronBrowserViewConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserView#getBounds:member(1)", "docComment": "/**\n * Returns the bounds of this view.\n *\n * @returns The view bounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBounds(): " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getBounds" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserView#setAutoResize:member(1)", "docComment": "/**\n * Configures how the view auto-resizes with its window.\n *\n * @param options - The auto-resize options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAutoResize(options: " }, { "kind": "Reference", "text": "ElectronAutoResizeOptions", "canonicalReference": "obsidian-typings!ElectronAutoResizeOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setAutoResize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserView#setBackgroundColor:member(1)", "docComment": "/**\n * Sets the background color of the view.\n *\n * @param color - The CSS color value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBackgroundColor(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setBackgroundColor" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserView#setBounds:member(1)", "docComment": "/**\n * Resizes and moves the view to the supplied bounds relative to the window.\n *\n * @param bounds - The new bounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBounds(bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "bounds", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setBounds" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserView#webContents:member", "docComment": "/**\n * The web contents owned by this view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronBrowserViewConstructorOptions:interface", "docComment": "/**\n * Options for creating an {@link ElectronBrowserView}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronBrowserViewConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronBrowserViewConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronBrowserViewConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserViewConstructorOptions#webPreferences:member", "docComment": "/**\n * Settings of web page's features.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webPreferences?: " }, { "kind": "Reference", "text": "WebPreferences", "canonicalReference": "obsidian-typings!WebPreferences:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webPreferences", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class", "docComment": "/**\n * Electron BrowserWindow for creating and managing application windows.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronBrowserWindow " } ], "fileUrlPath": "src/electron/internals/ElectronBrowserWindow.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronBrowserWindow", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronBrowserWindow}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options?: " }, { "kind": "Reference", "text": "BrowserWindowConstructorOptions", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#accessibleTitle:member", "docComment": "/**\n * An alternative title provided only to accessibility tools such as screen readers. This string is not directly visible to users.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accessibleTitle: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "accessibleTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addBrowserView:member(1)", "docComment": "/**\n * Replacement API for `setBrowserView` supporting work with multi browser views.\n *\n * @param browserView - The view to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addBrowserView(browserView: " }, { "kind": "Reference", "text": "ElectronBrowserView", "canonicalReference": "obsidian-typings!ElectronBrowserView:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "browserView", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addBrowserView" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(1)", "docComment": "/**\n * Registers a listener for the given window event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This BrowserWindow instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'always-on-top-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", isAlwaysOnTop: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(10)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'leave-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(11)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'leave-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(12)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'maximize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(13)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'minimize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(14)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(15)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'moved'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(16)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'new-window-for-tab'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(17)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'page-title-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", title: string, explicitSet: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(18)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'ready-to-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(19)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'resize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'app-command'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", command: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(20)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'resized'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(21)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'responsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(22)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'restore'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(23)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'rotate-gesture'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", rotation: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(24)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'scroll-touch-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(25)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'scroll-touch-edge'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(26)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'scroll-touch-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(27)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'session-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(28)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'sheet-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(29)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'sheet-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(30)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(31)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'swipe'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", direction: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(32)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'system-context-menu'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", point: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(33)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'unmaximize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 33, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(34)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'unresponsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 34, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(35)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newBounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 35, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(36)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-resize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newBounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronWillResizeDetails", "canonicalReference": "obsidian-typings!ElectronWillResizeDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 36, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'enter-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'enter-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(8)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addListener:member(9)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'hide'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#addTabbedWindow:member(1)", "docComment": "/**\n * Adds a window as a tab on this window, after the tab for the window instance (macOS only).\n *\n * @param browserWindow - The window to add as a tab.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addTabbedWindow(browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addTabbedWindow" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#autoHideMenuBar:member", "docComment": "/**\n * Whether the window menu bar should hide itself automatically.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoHideMenuBar: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "autoHideMenuBar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#blur:member(1)", "docComment": "/**\n * Removes focus from the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blur(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "blur" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#blurWebView:member(1)", "docComment": "/**\n * Removes focus from the web view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blurWebView(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "blurWebView" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#capturePage:member(1)", "docComment": "/**\n * Captures a snapshot of the page within `rect`. Omitting `rect` will capture the whole visible page.\n *\n * @param rect - The bounds to capture.\n *\n * @returns A promise that resolves with the captured image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "capturePage(rect?: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "capturePage" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#center:member(1)", "docComment": "/**\n * Moves window to the center of the screen.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "center(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "center" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#closable:member", "docComment": "/**\n * Whether the window can be manually closed by user. On Linux the setter is a no-op.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "closable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#close:member(1)", "docComment": "/**\n * Tries to close the window. This has the same effect as a user manually clicking the close button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "close" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#closeFilePreview:member(1)", "docComment": "/**\n * Closes the currently open Quick Look panel (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeFilePreview(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "closeFilePreview" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#destroy:member(1)", "docComment": "/**\n * Force-closes the window; the `unload` and `beforeunload` events won't be emitted, but `closed` is guaranteed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#documentEdited:member", "docComment": "/**\n * Whether the window's document has been edited (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "documentEdited: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "documentEdited", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#excludedFromShownWindowsMenu:member", "docComment": "/**\n * Whether the window is excluded from the application's Windows menu (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "excludedFromShownWindowsMenu: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "excludedFromShownWindowsMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#flashFrame:member(1)", "docComment": "/**\n * Starts or stops flashing the window to attract user's attention.\n *\n * @param flag - Whether to flash the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "flashFrame(flag: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "flag", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "flashFrame" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#focus:member(1)", "docComment": "/**\n * Focuses on the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "focus" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#focusable:member", "docComment": "/**\n * Whether the window is focusable (macOS and Windows).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#focusOnWebView:member(1)", "docComment": "/**\n * Focuses on the web view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusOnWebView(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "focusOnWebView" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow.fromBrowserView:member(1)", "docComment": "/**\n * Returns the window that owns the given `browserView`.\n *\n * @param browserView - The view to look up.\n *\n * @returns The owning BrowserWindow or `null` if the view is not attached to any window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromBrowserView(browserView: " }, { "kind": "Reference", "text": "ElectronBrowserView", "canonicalReference": "obsidian-typings!ElectronBrowserView:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "browserView", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "fromBrowserView" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow.fromId:member(1)", "docComment": "/**\n * Returns the window with the given `id`.\n *\n * @param id - The window id.\n *\n * @returns The BrowserWindow or `null` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromId(id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "fromId" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow.fromWebContents:member(1)", "docComment": "/**\n * Returns the window that owns the given `webContents`.\n *\n * @param webContents - The web contents to look up.\n *\n * @returns The owning BrowserWindow or `null` if the contents are not owned by a window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromWebContents(webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "webContents", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "fromWebContents" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#fullScreen:member", "docComment": "/**\n * Whether the window is in fullscreen mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fullScreen: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fullScreen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#fullScreenable:member", "docComment": "/**\n * Whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fullScreenable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fullScreenable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow.getAllWindows:member(1)", "docComment": "/**\n * Returns all opened browser windows.\n *\n * @returns An array of all BrowserWindow instances.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static getAllWindows(): " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getAllWindows" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getBackgroundColor:member(1)", "docComment": "/**\n * Returns the background color of the window in Hex (`#RRGGBB`) format.\n *\n * @returns The background color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBackgroundColor(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getBackgroundColor" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getBounds:member(1)", "docComment": "/**\n * Returns the bounds of the window.\n *\n * @returns The window bounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBounds(): " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getBounds" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getBrowserView:member(1)", "docComment": "/**\n * Returns the `BrowserView` attached to this window.\n *\n * @returns The attached view or `null` if one is not attached.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBrowserView(): " }, { "kind": "Reference", "text": "ElectronBrowserView", "canonicalReference": "obsidian-typings!ElectronBrowserView:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getBrowserView" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getBrowserViews:member(1)", "docComment": "/**\n * Returns all views attached with `addBrowserView` or `setBrowserView`.\n *\n * @returns An array of attached views.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBrowserViews(): " }, { "kind": "Reference", "text": "ElectronBrowserView", "canonicalReference": "obsidian-typings!ElectronBrowserView:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getBrowserViews" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getChildWindows:member(1)", "docComment": "/**\n * Returns all child windows.\n *\n * @returns An array of child windows.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getChildWindows(): " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getChildWindows" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getContentBounds:member(1)", "docComment": "/**\n * Returns the bounds of the window's client area.\n *\n * @returns The content bounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getContentBounds(): " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getContentBounds" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getContentSize:member(1)", "docComment": "/**\n * Returns the window's client area's width and height.\n *\n * @returns A tuple of `[width, height]`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getContentSize(): " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getContentSize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow.getFocusedWindow:member(1)", "docComment": "/**\n * Returns the window that is focused in this application.\n *\n * @returns The focused BrowserWindow or `null` if none is focused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static getFocusedWindow(): " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getFocusedWindow" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getMaximumSize:member(1)", "docComment": "/**\n * Returns the window's maximum width and height.\n *\n * @returns A tuple of `[width, height]`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMaximumSize(): " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getMaximumSize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getMediaSourceId:member(1)", "docComment": "/**\n * Returns the window id in the format of DesktopCapturerSource's id.\n *\n * @returns The media source id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMediaSourceId(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getMediaSourceId" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getMinimumSize:member(1)", "docComment": "/**\n * Returns the window's minimum width and height.\n *\n * @returns A tuple of `[width, height]`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMinimumSize(): " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getMinimumSize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getNativeWindowHandle:member(1)", "docComment": "/**\n * Returns the platform-specific handle of the window.\n *\n * @returns The native window handle buffer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNativeWindowHandle(): " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getNativeWindowHandle" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getNormalBounds:member(1)", "docComment": "/**\n * Returns the window bounds of the normal state, regardless of the current window state.\n *\n * @returns The normal-state bounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNormalBounds(): " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getNormalBounds" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getOpacity:member(1)", "docComment": "/**\n * Returns the opacity of the window, between `0.0` (fully transparent) and `1.0` (fully opaque). On Linux, always returns `1`.\n *\n * @returns The window opacity.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOpacity(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getOpacity" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getParentWindow:member(1)", "docComment": "/**\n * Returns the parent window.\n *\n * @returns The parent window or `null` if there is no parent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getParentWindow(): " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getParentWindow" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getPosition:member(1)", "docComment": "/**\n * Returns the window's current position.\n *\n * @returns A tuple of `[x, y]` coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPosition(): " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getPosition" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getRepresentedFilename:member(1)", "docComment": "/**\n * Returns the pathname of the file the window represents (macOS only).\n *\n * @returns The represented filename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRepresentedFilename(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getRepresentedFilename" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getSize:member(1)", "docComment": "/**\n * Returns the window's width and height.\n *\n * @returns A tuple of `[width, height]`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSize(): " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getSize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getTitle:member(1)", "docComment": "/**\n * Returns the title of the native window.\n *\n * @returns The window title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTitle(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getTitle" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#getTrafficLightPosition:member(1)", "docComment": "/**\n * Returns the custom position for the traffic light buttons in a frameless window (macOS only).\n *\n * @returns The traffic light position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTrafficLightPosition(): " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getTrafficLightPosition" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#hasShadow:member(1)", "docComment": "/**\n * Returns whether the window has a shadow.\n *\n * @returns Whether the window has a shadow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasShadow(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "hasShadow" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#hide:member(1)", "docComment": "/**\n * Hides the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hide(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "hide" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#hookWindowMessage:member(1)", "docComment": "/**\n * Hooks a windows message. The `callback` is called when the message is received in the WndProc (Windows only).\n *\n * @param message - The message identifier.\n *\n * @param callback - The callback invoked when the message is received.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hookWindowMessage(message: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(wParam: unknown, lParam: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "hookWindowMessage" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#id:member", "docComment": "/**\n * The unique identifier of the window, unique among all `BrowserWindow` instances of the entire application.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isAlwaysOnTop:member(1)", "docComment": "/**\n * Returns whether the window is always on top of other windows.\n *\n * @returns Whether the window is always on top.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAlwaysOnTop(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isAlwaysOnTop" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isClosable:member(1)", "docComment": "/**\n * Returns whether the window can be manually closed by user. On Linux always returns `true` (macOS and Windows).\n *\n * @returns Whether the window is closable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isClosable(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isClosable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isDestroyed:member(1)", "docComment": "/**\n * Returns whether the window has been destroyed.\n *\n * @returns Whether the window is destroyed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDestroyed(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isDestroyed" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isDocumentEdited:member(1)", "docComment": "/**\n * Returns whether the window's document has been edited (macOS only).\n *\n * @returns Whether the document has been edited.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDocumentEdited(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isDocumentEdited" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isEnabled:member(1)", "docComment": "/**\n * Returns whether the window is enabled.\n *\n * @returns Whether the window is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEnabled(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isEnabled" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isFocusable:member(1)", "docComment": "/**\n * Returns whether the window can be focused (macOS and Windows).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isFocusable(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isFocusable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isFocused:member(1)", "docComment": "/**\n * Returns whether the window is focused.\n *\n * @returns Whether the window is focused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isFocused(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isFocused" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isFullScreen:member(1)", "docComment": "/**\n * Returns whether the window is in fullscreen mode.\n *\n * @returns Whether the window is fullscreen.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isFullScreen(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isFullScreen" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isFullScreenable:member(1)", "docComment": "/**\n * Returns whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.\n *\n * @returns Whether the window is fullscreenable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isFullScreenable(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isFullScreenable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isKiosk:member(1)", "docComment": "/**\n * Returns whether the window is in kiosk mode.\n *\n * @returns Whether the window is in kiosk mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isKiosk(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isKiosk" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isMaximizable:member(1)", "docComment": "/**\n * Returns whether the window can be manually maximized by user. On Linux always returns `true` (macOS and Windows).\n *\n * @returns Whether the window is maximizable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMaximizable(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isMaximizable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isMaximized:member(1)", "docComment": "/**\n * Returns whether the window is maximized.\n *\n * @returns Whether the window is maximized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMaximized(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isMaximized" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isMenuBarAutoHide:member(1)", "docComment": "/**\n * Returns whether the menu bar automatically hides itself.\n *\n * @returns Whether the menu bar auto-hides.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMenuBarAutoHide(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isMenuBarAutoHide" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isMenuBarVisible:member(1)", "docComment": "/**\n * Returns whether the menu bar is visible.\n *\n * @returns Whether the menu bar is visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMenuBarVisible(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isMenuBarVisible" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isMinimizable:member(1)", "docComment": "/**\n * Returns whether the window can be manually minimized by user. On Linux always returns `true` (macOS and Windows).\n *\n * @returns Whether the window is minimizable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMinimizable(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isMinimizable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isMinimized:member(1)", "docComment": "/**\n * Returns whether the window is minimized.\n *\n * @returns Whether the window is minimized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMinimized(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isMinimized" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isModal:member(1)", "docComment": "/**\n * Returns whether the current window is a modal window.\n *\n * @returns Whether the window is modal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isModal(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isModal" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isMovable:member(1)", "docComment": "/**\n * Returns whether the window can be moved by user. On Linux always returns `true` (macOS and Windows).\n *\n * @returns Whether the window is movable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMovable(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isMovable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isNormal:member(1)", "docComment": "/**\n * Returns whether the window is in normal state (not maximized, not minimized, not in fullscreen mode).\n *\n * @returns Whether the window is in normal state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isNormal(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isNormal" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isResizable:member(1)", "docComment": "/**\n * Returns whether the window can be manually resized by user.\n *\n * @returns Whether the window is resizable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isResizable(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isResizable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isSimpleFullScreen:member(1)", "docComment": "/**\n * Returns whether the window is in simple (pre-Lion) fullscreen mode (macOS only).\n *\n * @returns Whether the window is in simple fullscreen mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isSimpleFullScreen(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isSimpleFullScreen" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isTabletMode:member(1)", "docComment": "/**\n * Returns whether the window is in Windows 10 tablet mode (Windows only).\n *\n * @returns Whether the window is in tablet mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isTabletMode(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isTabletMode" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isVisible:member(1)", "docComment": "/**\n * Returns whether the window is visible to the user.\n *\n * @returns Whether the window is visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isVisible(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isVisible" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isVisibleOnAllWorkspaces:member(1)", "docComment": "/**\n * Returns whether the window is visible on all workspaces. Always returns `false` on Windows.\n *\n * @returns Whether the window is visible on all workspaces.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isVisibleOnAllWorkspaces(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isVisibleOnAllWorkspaces" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#isWindowMessageHooked:member(1)", "docComment": "/**\n * Returns whether the message is hooked (Windows only).\n *\n * @param message - The message identifier.\n *\n * @returns Whether the message is hooked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isWindowMessageHooked(message: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "isWindowMessageHooked" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#kiosk:member", "docComment": "/**\n * Whether the window is in kiosk mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "kiosk: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "kiosk", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#loadFile:member(1)", "docComment": "/**\n * Loads a file into the window. Same as `webContents.loadFile`.\n *\n * @param filePath - The path to an HTML file relative to the root of the application.\n *\n * @param options - Options for loading the file.\n *\n * @returns A promise that resolves when the page has finished loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadFile(filePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronBrowserWindowLoadFileOptions", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadFileOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "filePath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "loadFile" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#loadURL:member(1)", "docComment": "/**\n * Loads a URL into the window. Same as `webContents.loadURL`.\n *\n * @param url - A remote address or a path to a local HTML file using the `file://` protocol.\n *\n * @param options - Options for loading the URL.\n *\n * @returns A promise that resolves when the page has finished loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadURL(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronBrowserWindowLoadURLOptions", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "loadURL" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#maximizable:member", "docComment": "/**\n * Whether the window can be manually maximized by user. On Linux the setter is a no-op.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maximizable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "maximizable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#maximize:member(1)", "docComment": "/**\n * Maximizes the window. This will also show (but not focus) the window if it isn't being displayed already.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maximize(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "maximize" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#menuBarVisible:member", "docComment": "/**\n * Whether the menu bar should be visible (Windows and Linux).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "menuBarVisible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "menuBarVisible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#mergeAllWindows:member(1)", "docComment": "/**\n * Merges all windows into one window with multiple tabs when native tabs are enabled (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mergeAllWindows(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "mergeAllWindows" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#minimizable:member", "docComment": "/**\n * Whether the window can be manually minimized by user. On Linux the setter is a no-op.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minimizable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minimizable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#minimize:member(1)", "docComment": "/**\n * Minimizes the window. On some platforms the minimized window will be shown in the Dock.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minimize(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "minimize" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#movable:member", "docComment": "/**\n * Whether the window can be moved by user. On Linux the setter is a no-op.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "movable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "movable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#moveAbove:member(1)", "docComment": "/**\n * Moves window above the source window in the sense of z-order.\n *\n * @param mediaSourceId - The media source id of the window to move above.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveAbove(mediaSourceId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "mediaSourceId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "moveAbove" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#moveTabToNewWindow:member(1)", "docComment": "/**\n * Moves the current tab into a new window if native tabs are enabled and there is more than one tab (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveTabToNewWindow(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "moveTabToNewWindow" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#moveTop:member(1)", "docComment": "/**\n * Moves window to top (z-order) regardless of focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveTop(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "moveTop" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(1)", "docComment": "/**\n * Registers a listener for the given window event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This BrowserWindow instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'always-on-top-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", isAlwaysOnTop: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(10)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'leave-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(11)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'leave-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(12)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'maximize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(13)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'minimize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(14)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(15)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'moved'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(16)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'new-window-for-tab'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(17)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'page-title-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", title: string, explicitSet: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(18)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'ready-to-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(19)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'resize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'app-command'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", command: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(20)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'resized'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(21)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'responsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(22)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'restore'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(23)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'rotate-gesture'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", rotation: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(24)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'scroll-touch-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(25)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'scroll-touch-edge'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(26)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'scroll-touch-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(27)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'session-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(28)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'sheet-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(29)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'sheet-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(30)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(31)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'swipe'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", direction: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(32)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'system-context-menu'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", point: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(33)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'unmaximize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 33, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(34)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'unresponsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 34, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(35)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newBounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 35, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(36)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-resize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newBounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronWillResizeDetails", "canonicalReference": "obsidian-typings!ElectronWillResizeDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 36, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'enter-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'enter-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(8)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#on:member(9)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'hide'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the given window event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This BrowserWindow instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'always-on-top-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", isAlwaysOnTop: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(10)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'leave-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(11)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'leave-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(12)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'maximize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(13)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'minimize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(14)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(15)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'moved'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(16)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'new-window-for-tab'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(17)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'page-title-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", title: string, explicitSet: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(18)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'ready-to-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(19)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'resize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'app-command'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", command: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(20)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'resized'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(21)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'responsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(22)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'restore'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(23)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'rotate-gesture'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", rotation: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(24)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'scroll-touch-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(25)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'scroll-touch-edge'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(26)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'scroll-touch-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(27)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'session-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(28)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'sheet-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(29)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'sheet-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(30)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(31)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'swipe'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", direction: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(32)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'system-context-menu'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", point: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(33)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'unmaximize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 33, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(34)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'unresponsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 34, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(35)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newBounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 35, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(36)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-resize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newBounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronWillResizeDetails", "canonicalReference": "obsidian-typings!ElectronWillResizeDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 36, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'enter-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'enter-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(8)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#once:member(9)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'hide'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#previewFile:member(1)", "docComment": "/**\n * Uses Quick Look to preview a file at a given path (macOS only).\n *\n * @param path - The path to the file to preview.\n *\n * @param displayName - The name of the file to display in the Quick Look modal view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "previewFile(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", displayName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "displayName", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "previewFile" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#reload:member(1)", "docComment": "/**\n * Reloads the current page. Same as `webContents.reload`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "reload" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeBrowserView:member(1)", "docComment": "/**\n * Removes a view added with `addBrowserView` or `setBrowserView`.\n *\n * @param browserView - The view to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeBrowserView(browserView: " }, { "kind": "Reference", "text": "ElectronBrowserView", "canonicalReference": "obsidian-typings!ElectronBrowserView:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "browserView", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeBrowserView" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(1)", "docComment": "/**\n * Removes a listener for the given window event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This BrowserWindow instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'always-on-top-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", isAlwaysOnTop: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(10)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'leave-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(11)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'leave-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(12)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'maximize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(13)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'minimize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(14)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(15)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'moved'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(16)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'new-window-for-tab'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(17)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'page-title-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", title: string, explicitSet: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(18)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'ready-to-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(19)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'resize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'app-command'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", command: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(20)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'resized'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(21)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'responsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(22)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'restore'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(23)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'rotate-gesture'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", rotation: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(24)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'scroll-touch-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(25)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'scroll-touch-edge'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(26)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'scroll-touch-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(27)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'session-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(28)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'sheet-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(29)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'sheet-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(30)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(31)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'swipe'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", direction: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(32)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'system-context-menu'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", point: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(33)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'unmaximize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 33, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(34)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'unresponsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 34, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(35)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newBounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 35, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(36)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-resize'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newBounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronWillResizeDetails", "canonicalReference": "obsidian-typings!ElectronWillResizeDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 36, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'enter-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'enter-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(8)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeListener:member(9)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'hide'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#removeMenu:member(1)", "docComment": "/**\n * Removes the window's menu bar (Linux and Windows).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeMenu(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "removeMenu" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#representedFilename:member", "docComment": "/**\n * The pathname of the file the window represents (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "representedFilename: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "representedFilename", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#resizable:member", "docComment": "/**\n * Whether the window can be manually resized by user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resizable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resizable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#restore:member(1)", "docComment": "/**\n * Restores the window from minimized state to its previous state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "restore(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "restore" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#selectNextTab:member(1)", "docComment": "/**\n * Selects the next tab when native tabs are enabled and there are other tabs in the window (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectNextTab(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "selectNextTab" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#selectPreviousTab:member(1)", "docComment": "/**\n * Selects the previous tab when native tabs are enabled and there are other tabs in the window (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectPreviousTab(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "selectPreviousTab" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setAlwaysOnTop:member(1)", "docComment": "/**\n * Sets whether the window should show always on top of other windows.\n *\n * @param flag - Whether to set always on top.\n *\n * @param level - The always-on-top level (macOS only).\n *\n * @param relativeLevel - The number of layers higher to set this window relative to the given `level`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAlwaysOnTop(flag: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", level?: " }, { "kind": "Content", "text": "'floating' | 'main-menu' | 'modal-panel' | 'normal' | 'pop-up-menu' | 'screen-saver' | 'status' | 'torn-off-menu'" }, { "kind": "Content", "text": ", relativeLevel?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "flag", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "level", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "relativeLevel", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setAlwaysOnTop" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setAppDetails:member(1)", "docComment": "/**\n * Sets the properties for the window's taskbar button (Windows only).\n *\n * @param options - The taskbar button properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAppDetails(options: " }, { "kind": "Reference", "text": "ElectronAppDetailsOptions", "canonicalReference": "obsidian-typings!ElectronAppDetailsOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setAppDetails" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setAspectRatio:member(1)", "docComment": "/**\n * Makes the window maintain an aspect ratio.\n *\n * @param aspectRatio - The aspect ratio to maintain.\n *\n * @param extraSize - Extra size not included within the aspect ratio calculations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAspectRatio(aspectRatio: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", extraSize?: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "aspectRatio", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "extraSize", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setAspectRatio" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setAutoHideCursor:member(1)", "docComment": "/**\n * Controls whether to hide the cursor when typing (macOS only).\n *\n * @param autoHide - Whether to auto-hide the cursor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAutoHideCursor(autoHide: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "autoHide", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setAutoHideCursor" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setAutoHideMenuBar:member(1)", "docComment": "/**\n * Sets whether the window menu bar should hide itself automatically.\n *\n * @param hide - Whether to auto-hide the menu bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAutoHideMenuBar(hide: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "hide", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setAutoHideMenuBar" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setBackgroundColor:member(1)", "docComment": "/**\n * Sets the background color of the window.\n *\n * @param backgroundColor - The CSS color value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBackgroundColor(backgroundColor: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "backgroundColor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setBackgroundColor" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setBounds:member(1)", "docComment": "/**\n * Resizes and moves the window to the supplied bounds. Any properties not supplied default to their current values.\n *\n * @param bounds - The new bounds.\n *\n * @param animate - Whether to animate the transition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBounds(bounds: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", animate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "bounds", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false }, { "parameterName": "animate", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setBounds" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setBrowserView:member(1)", "docComment": "/**\n * Sets the view attached to the window.\n *\n * @param browserView - The view to attach, or `null` to detach.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBrowserView(browserView: " }, { "kind": "Reference", "text": "ElectronBrowserView", "canonicalReference": "obsidian-typings!ElectronBrowserView:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "browserView", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setBrowserView" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setClosable:member(1)", "docComment": "/**\n * Sets whether the window can be manually closed by user. On Linux does nothing (macOS and Windows).\n *\n * @param closable - Whether the window is closable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setClosable(closable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "closable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setClosable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setContentBounds:member(1)", "docComment": "/**\n * Resizes and moves the window's client area to the supplied bounds.\n *\n * @param bounds - The new content bounds.\n *\n * @param animate - Whether to animate the transition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setContentBounds(bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", animate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "bounds", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "animate", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setContentBounds" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setContentProtection:member(1)", "docComment": "/**\n * Prevents the window contents from being captured by other apps (macOS and Windows).\n *\n * @param enable - Whether to enable content protection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setContentProtection(enable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "enable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setContentProtection" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setContentSize:member(1)", "docComment": "/**\n * Resizes the window's client area to `width` and `height`.\n *\n * @param width - The new width.\n *\n * @param height - The new height.\n *\n * @param animate - Whether to animate the transition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setContentSize(width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", animate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "animate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setContentSize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setDocumentEdited:member(1)", "docComment": "/**\n * Specifies whether the window's document has been edited (macOS only).\n *\n * @param edited - Whether the document has been edited.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDocumentEdited(edited: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "edited", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDocumentEdited" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setEnabled:member(1)", "docComment": "/**\n * Disables or enables the window.\n *\n * @param enable - Whether to enable the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setEnabled(enable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "enable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setEnabled" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setFocusable:member(1)", "docComment": "/**\n * Changes whether the window can be focused (macOS and Windows).\n *\n * @param focusable - Whether the window is focusable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFocusable(focusable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "focusable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setFocusable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setFullScreen:member(1)", "docComment": "/**\n * Sets whether the window should be in fullscreen mode.\n *\n * @param flag - Whether to enable fullscreen.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFullScreen(flag: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "flag", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setFullScreen" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setFullScreenable:member(1)", "docComment": "/**\n * Sets whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.\n *\n * @param fullscreenable - Whether the window is fullscreenable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFullScreenable(fullscreenable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "fullscreenable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setFullScreenable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setHasShadow:member(1)", "docComment": "/**\n * Sets whether the window should have a shadow.\n *\n * @param hasShadow - Whether the window should have a shadow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHasShadow(hasShadow: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "hasShadow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setHasShadow" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setIcon:member(1)", "docComment": "/**\n * Changes the window icon (Linux and Windows).\n *\n * @param icon - The icon image or path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIcon(icon: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "icon", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIcon" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setIgnoreMouseEvents:member(1)", "docComment": "/**\n * Makes the window ignore all mouse events.\n *\n * @param ignore - Whether to ignore mouse events.\n *\n * @param options - Additional options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIgnoreMouseEvents(ignore: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronIgnoreMouseEventsOptions", "canonicalReference": "obsidian-typings!ElectronIgnoreMouseEventsOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "ignore", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setIgnoreMouseEvents" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setKiosk:member(1)", "docComment": "/**\n * Enters or leaves kiosk mode.\n *\n * @param flag - Whether to enable kiosk mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setKiosk(flag: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "flag", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setKiosk" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setMaximizable:member(1)", "docComment": "/**\n * Sets whether the window can be manually maximized by user. On Linux does nothing (macOS and Windows).\n *\n * @param maximizable - Whether the window is maximizable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMaximizable(maximizable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "maximizable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setMaximizable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setMaximumSize:member(1)", "docComment": "/**\n * Sets the maximum size of the window.\n *\n * @param width - The maximum width.\n *\n * @param height - The maximum height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMaximumSize(width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setMaximumSize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setMenu:member(1)", "docComment": "/**\n * Sets the menu as the window's menu bar (Linux and Windows).\n *\n * @param menu - The menu to set, or `null` to remove it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMenu(menu: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setMenu" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setMenuBarVisibility:member(1)", "docComment": "/**\n * Sets whether the menu bar should be visible (Linux and Windows).\n *\n * @param visible - Whether the menu bar is visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMenuBarVisibility(visible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "visible", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setMenuBarVisibility" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setMinimizable:member(1)", "docComment": "/**\n * Sets whether the window can be manually minimized by user. On Linux does nothing (macOS and Windows).\n *\n * @param minimizable - Whether the window is minimizable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMinimizable(minimizable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "minimizable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setMinimizable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setMinimumSize:member(1)", "docComment": "/**\n * Sets the minimum size of the window.\n *\n * @param width - The minimum width.\n *\n * @param height - The minimum height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMinimumSize(width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setMinimumSize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setMovable:member(1)", "docComment": "/**\n * Sets whether the window can be moved by user. On Linux does nothing (macOS and Windows).\n *\n * @param movable - Whether the window is movable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMovable(movable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "movable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setMovable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setOpacity:member(1)", "docComment": "/**\n * Sets the opacity of the window. On Linux, does nothing. Out of bound values are clamped to the `[0, 1]` range.\n *\n * @param opacity - The opacity value between `0.0` and `1.0`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOpacity(opacity: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "opacity", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setOpacity" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setOverlayIcon:member(1)", "docComment": "/**\n * Sets a 16 x 16 pixel overlay onto the current taskbar icon (Windows only).\n *\n * @param overlay - The overlay image, or `null` to remove the overlay.\n *\n * @param description - A description of the overlay for accessibility tools.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOverlayIcon(overlay: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", description: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "overlay", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "description", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setOverlayIcon" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setParentWindow:member(1)", "docComment": "/**\n * Sets the parent window. Passing `null` will turn the current window into a top-level window.\n *\n * @param parent - The new parent window, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setParentWindow(parent: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "parent", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setParentWindow" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setPosition:member(1)", "docComment": "/**\n * Moves the window to `x` and `y`.\n *\n * @param x - The x coordinate.\n *\n * @param y - The y coordinate.\n *\n * @param animate - Whether to animate the transition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPosition(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", animate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "animate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setPosition" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setProgressBar:member(1)", "docComment": "/**\n * Sets the progress value in the progress bar. Valid range is `[0, 1.0]`.\n *\n * @param progress - The progress value.\n *\n * @param options - Additional options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setProgressBar(progress: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronProgressBarOptions", "canonicalReference": "obsidian-typings!ElectronProgressBarOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "progress", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setProgressBar" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setRepresentedFilename:member(1)", "docComment": "/**\n * Sets the pathname of the file the window represents (macOS only).\n *\n * @param filename - The represented filename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setRepresentedFilename(filename: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "filename", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setRepresentedFilename" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setResizable:member(1)", "docComment": "/**\n * Sets whether the window can be manually resized by user.\n *\n * @param resizable - Whether the window is resizable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setResizable(resizable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "resizable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setResizable" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setShape:member(1)", "docComment": "/**\n * Sets a window shape determining the area within the window where drawing and user interaction are permitted (Linux and Windows).\n *\n * @param rects - The rectangles defining the window shape.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setShape(rects: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "rects", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setShape" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setSheetOffset:member(1)", "docComment": "/**\n * Changes the attachment point for sheets on macOS (macOS only).\n *\n * @param offsetY - The vertical offset.\n *\n * @param offsetX - The horizontal offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSheetOffset(offsetY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", offsetX?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "offsetY", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "offsetX", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setSheetOffset" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setSimpleFullScreen:member(1)", "docComment": "/**\n * Enters or leaves simple fullscreen mode (macOS only).\n *\n * @param flag - Whether to enable simple fullscreen mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSimpleFullScreen(flag: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "flag", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setSimpleFullScreen" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setSize:member(1)", "docComment": "/**\n * Resizes the window to `width` and `height`.\n *\n * @param width - The new width.\n *\n * @param height - The new height.\n *\n * @param animate - Whether to animate the transition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSize(width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", animate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "animate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setSize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setSkipTaskbar:member(1)", "docComment": "/**\n * Makes the window not show in the taskbar.\n *\n * @param skip - Whether to skip the taskbar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSkipTaskbar(skip: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "skip", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setSkipTaskbar" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setThumbarButtons:member(1)", "docComment": "/**\n * Adds a thumbnail toolbar with a specified set of buttons to the thumbnail image of a window (Windows only).\n *\n * @param buttons - The buttons to add.\n *\n * @returns Whether the buttons were added successfully.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setThumbarButtons(buttons: " }, { "kind": "Reference", "text": "ElectronThumbarButton", "canonicalReference": "obsidian-typings!ElectronThumbarButton:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "buttons", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setThumbarButtons" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setThumbnailClip:member(1)", "docComment": "/**\n * Sets the region of the window to show as the thumbnail image displayed when hovering over the window in the taskbar (Windows only).\n *\n * @param region - The region to show as the thumbnail.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setThumbnailClip(region: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "region", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setThumbnailClip" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setThumbnailToolTip:member(1)", "docComment": "/**\n * Sets the tooltip displayed when hovering over the window thumbnail in the taskbar (Windows only).\n *\n * @param toolTip - The tooltip text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setThumbnailToolTip(toolTip: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "toolTip", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setThumbnailToolTip" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setTitle:member(1)", "docComment": "/**\n * Changes the title of the native window.\n *\n * @param title - The new title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTitle(title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setTitle" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setTitleBarOverlay:member(1)", "docComment": "/**\n * On a window with Window Controls Overlay already enabled, updates the style of the title bar overlay (Windows only).\n *\n * @param options - The title bar overlay style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTitleBarOverlay(options: " }, { "kind": "Reference", "text": "ElectronTitleBarOverlayOptions", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlayOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setTitleBarOverlay" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setTopBrowserView:member(1)", "docComment": "/**\n * Raises `browserView` above other views attached to the window.\n *\n * @param browserView - The view to raise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTopBrowserView(browserView: " }, { "kind": "Reference", "text": "ElectronBrowserView", "canonicalReference": "obsidian-typings!ElectronBrowserView:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "browserView", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setTopBrowserView" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setTouchBar:member(1)", "docComment": "/**\n * Sets the touch bar layout for the current window. Specifying `null` or `undefined` clears the touch bar (macOS only).\n *\n * @param touchBar - The touch bar, or `null` to clear it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTouchBar(touchBar: " }, { "kind": "Reference", "text": "ElectronTouchBar", "canonicalReference": "obsidian-typings!ElectronTouchBar:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "touchBar", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setTouchBar" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setTrafficLightPosition:member(1)", "docComment": "/**\n * Sets a custom position for the traffic light buttons in a frameless window (macOS only).\n *\n * @param position - The traffic light position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTrafficLightPosition(position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "position", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setTrafficLightPosition" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setVibrancy:member(1)", "docComment": "/**\n * Adds a vibrancy effect to the browser window. Passing `null` or an empty string removes the effect (macOS only).\n *\n * @param type - The vibrancy type, or `null` to remove the effect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setVibrancy(type: " }, { "kind": "Content", "text": "'appearance-based' | 'content' | 'dark' | 'fullscreen-ui' | 'header' | 'hud' | 'light' | 'medium-light' | 'menu' | 'popover' | 'selection' | 'sheet' | 'sidebar' | 'titlebar' | 'tooltip' | 'ultra-dark' | 'under-page' | 'under-window' | 'window' | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setVibrancy" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setVisibleOnAllWorkspaces:member(1)", "docComment": "/**\n * Sets whether the window should be visible on all workspaces. Does nothing on Windows.\n *\n * @param visible - Whether the window is visible on all workspaces.\n *\n * @param options - Additional options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setVisibleOnAllWorkspaces(visible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronVisibleOnAllWorkspacesOptions", "canonicalReference": "obsidian-typings!ElectronVisibleOnAllWorkspacesOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "visible", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setVisibleOnAllWorkspaces" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#setWindowButtonVisibility:member(1)", "docComment": "/**\n * Sets whether the window traffic light buttons should be visible (macOS only).\n *\n * @param visible - Whether the traffic light buttons are visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setWindowButtonVisibility(visible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "visible", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setWindowButtonVisibility" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#shadow:member", "docComment": "/**\n * Whether the window has a shadow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shadow: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "shadow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#show:member(1)", "docComment": "/**\n * Shows and gives focus to the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "show(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "show" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#showDefinitionForSelection:member(1)", "docComment": "/**\n * Shows the definition for the selected word (macOS only). Same as `webContents.showDefinitionForSelection()`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showDefinitionForSelection(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "showDefinitionForSelection" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#showInactive:member(1)", "docComment": "/**\n * Shows the window but doesn't focus on it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showInactive(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "showInactive" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#simpleFullScreen:member", "docComment": "/**\n * Whether the window is in simple (pre-Lion) fullscreen mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "simpleFullScreen: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "simpleFullScreen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#title:member", "docComment": "/**\n * The title of the native window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#toggleTabBar:member(1)", "docComment": "/**\n * Toggles the visibility of the tab bar if native tabs are enabled and there is only one tab (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleTabBar(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "toggleTabBar" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#unhookAllWindowMessages:member(1)", "docComment": "/**\n * Unhooks all of the window messages (Windows only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unhookAllWindowMessages(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "unhookAllWindowMessages" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#unhookWindowMessage:member(1)", "docComment": "/**\n * Unhooks the window message (Windows only).\n *\n * @param message - The message identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unhookWindowMessage(message: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "unhookWindowMessage" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#unmaximize:member(1)", "docComment": "/**\n * Unmaximizes the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unmaximize(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "unmaximize" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#visibleOnAllWorkspaces:member", "docComment": "/**\n * Whether the window is visible on all workspaces. Always returns `false` on Windows.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "visibleOnAllWorkspaces: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "visibleOnAllWorkspaces", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronBrowserWindow#webContents:member", "docComment": "/**\n * The web contents owned by this window. All web page related events and operations will be done via it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadFileOptions:interface", "docComment": "/**\n * Options for {@link ElectronBrowserWindow.loadFile}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronBrowserWindowLoadFileOptions " } ], "fileUrlPath": "src/electron/internals/ElectronBrowserWindowLoadFileOptions.d.ts", "releaseTag": "Public", "name": "ElectronBrowserWindowLoadFileOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadFileOptions#hash:member", "docComment": "/**\n * Passed to `url.format()`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hash?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hash", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadFileOptions#query:member", "docComment": "/**\n * Passed to `url.format()`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadFileOptions#search:member", "docComment": "/**\n * Passed to `url.format()`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "search?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "search", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions:interface", "docComment": "/**\n * Options for {@link ElectronBrowserWindow.loadURL}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronBrowserWindowLoadURLOptions " } ], "fileUrlPath": "src/electron/internals/ElectronBrowserWindowLoadURLOptions.d.ts", "releaseTag": "Public", "name": "ElectronBrowserWindowLoadURLOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions#baseURLForDataURL:member", "docComment": "/**\n * Base url (with trailing path separator) for files to be loaded by the data url. This is needed only if the specified `url` is a data url and needs to load other files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "baseURLForDataURL?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "baseURLForDataURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions#extraHeaders:member", "docComment": "/**\n * Extra headers separated by `\\n`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extraHeaders?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "extraHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions#httpReferrer:member", "docComment": "/**\n * An HTTP Referrer url.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "httpReferrer?: " }, { "kind": "Reference", "text": "ElectronReferrer", "canonicalReference": "obsidian-typings!ElectronReferrer:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "httpReferrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions#postData:member", "docComment": "/**\n * The post data to send with the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postData?: " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ElectronUploadFile", "canonicalReference": "obsidian-typings!ElectronUploadFile:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronUploadRawData", "canonicalReference": "obsidian-typings!ElectronUploadRawData:interface" }, { "kind": "Content", "text": ")[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "postData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions#userAgent:member", "docComment": "/**\n * A user agent originating the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userAgent?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "userAgent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCertificate:interface", "docComment": "/**\n * An Electron certificate.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCertificate " } ], "fileUrlPath": "src/electron/internals/ElectronCertificate.d.ts", "releaseTag": "Public", "name": "ElectronCertificate", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#data:member", "docComment": "/**\n * PEM encoded data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#fingerprint:member", "docComment": "/**\n * Fingerprint of the certificate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fingerprint: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fingerprint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#issuer:member", "docComment": "/**\n * Issuer principal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "issuer: " }, { "kind": "Reference", "text": "ElectronCertificatePrincipal", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "issuer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#issuerCert:member", "docComment": "/**\n * Issuer certificate (if not self-signed).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "issuerCert: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "issuerCert", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#issuerName:member", "docComment": "/**\n * Issuer's Common Name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "issuerName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "issuerName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#serialNumber:member", "docComment": "/**\n * Hex value represented string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialNumber: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "serialNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#subject:member", "docComment": "/**\n * Subject principal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subject: " }, { "kind": "Reference", "text": "ElectronCertificatePrincipal", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subject", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#subjectName:member", "docComment": "/**\n * Subject's Common Name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subjectName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subjectName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#validExpiry:member", "docComment": "/**\n * End date of the certificate being valid in seconds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "validExpiry: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "validExpiry", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificate#validStart:member", "docComment": "/**\n * Start date of the certificate being valid in seconds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "validStart: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "validStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal:interface", "docComment": "/**\n * Principal (subject or issuer) of an Electron certificate.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCertificatePrincipal " } ], "fileUrlPath": "src/electron/internals/ElectronCertificatePrincipal.d.ts", "releaseTag": "Public", "name": "ElectronCertificatePrincipal", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal#commonName:member", "docComment": "/**\n * Common Name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commonName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "commonName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal#country:member", "docComment": "/**\n * Country or region.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "country: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "country", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal#locality:member", "docComment": "/**\n * Locality.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "locality: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "locality", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal#organizations:member", "docComment": "/**\n * Organization names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "organizations: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "organizations", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal#organizationUnits:member", "docComment": "/**\n * Organization Unit names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "organizationUnits: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "organizationUnits", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificatePrincipal#state:member", "docComment": "/**\n * State or province.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCertificateTrustDialogOptions:interface", "docComment": "/**\n * Options for Electron certificate trust dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCertificateTrustDialogOptions " } ], "fileUrlPath": "src/electron/internals/ElectronCertificateTrustDialogOptions.d.ts", "releaseTag": "Public", "name": "ElectronCertificateTrustDialogOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificateTrustDialogOptions#certificate:member", "docComment": "/**\n * The certificate to trust/import.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "certificate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCertificateTrustDialogOptions#message:member", "docComment": "/**\n * The message to display to the user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronClearCodeCachesOptions:interface", "docComment": "/**\n * Options controlling which code caches are cleared.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronClearCodeCachesOptions " } ], "fileUrlPath": "src/electron/internals/ElectronClearCodeCachesOptions.d.ts", "releaseTag": "Public", "name": "ElectronClearCodeCachesOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClearCodeCachesOptions#urls:member", "docComment": "/**\n * An array of URLs corresponding to the resources whose generated code cache needs to be removed. If empty, all entries are removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "urls?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "urls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronClearStorageDataOptions:interface", "docComment": "/**\n * Options controlling which storage data is cleared.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronClearStorageDataOptions " } ], "fileUrlPath": "src/electron/internals/ElectronClearStorageDataOptions.d.ts", "releaseTag": "Public", "name": "ElectronClearStorageDataOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClearStorageDataOptions#origin:member", "docComment": "/**\n * Should follow `window.location.origin`'s representation `scheme://host:port`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClearStorageDataOptions#quotas:member", "docComment": "/**\n * The types of quotas to clear, can contain `persistent`, `syncable` or `temporary`. If not specified, clear all quotas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "quotas?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "quotas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClearStorageDataOptions#storages:member", "docComment": "/**\n * The types of storages to clear. If not specified, clear all storage types.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storages?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "storages", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronClientRequest:class", "docComment": "/**\n * An HTTP/HTTPS request issued through the `net` module.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronClientRequest " } ], "fileUrlPath": "src/electron/internals/ElectronClientRequest.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronClientRequest", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronClientRequest:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronClientRequest}.\n *\n * @param options - The request options, or the request URL as a string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronClientRequestConstructorOptions", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#abort:member(1)", "docComment": "/**\n * Cancels an ongoing HTTP transaction. If the request has already emitted the `close` event, the abort operation will have no effect. Otherwise an ongoing event will emit `abort` and `close` events. Additionally, if there is an ongoing response object, it will emit the `aborted` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "abort(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "abort" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#addListener:member(1)", "docComment": "/**\n * Registers a listener for the given request event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ClientRequest` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'abort'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#addListener:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#addListener:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#addListener:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'finish'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#addListener:member(5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#addListener:member(6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'redirect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(statusCode: number, method: string, redirectUrl: string, responseHeaders: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string[]>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#addListener:member(7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'response'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(response: " }, { "kind": "Reference", "text": "ElectronIncomingMessage", "canonicalReference": "obsidian-typings!ElectronIncomingMessage:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronClientRequest#chunkedEncoding:member", "docComment": "/**\n * A `boolean` specifying whether the request will use HTTP chunked transfer encoding or not. The property is readable and writable, however it can be set only before the first write operation as the HTTP headers are not yet put on the wire. Trying to set the `chunkedEncoding` property after the first write will throw an error.\n *\n * Using chunked encoding is strongly recommended if you need to send a large request body as data will be streamed in small chunks instead of being internally buffered inside Electron process memory.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "chunkedEncoding: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "chunkedEncoding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#end:member(1)", "docComment": "/**\n * Sends the last chunk of the request data. Subsequent write or end operations will not be allowed. The `finish` event is emitted just after the end operation.\n *\n * @param chunk - The final chunk of request body data.\n *\n * @param encoding - The encoding of `chunk`.\n *\n * @param callback - Invoked after the chunk content has been delivered to the Chromium networking layer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "end(chunk?: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", encoding?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "chunk", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true }, { "parameterName": "encoding", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "end" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#followRedirect:member(1)", "docComment": "/**\n * Continues any pending redirection. Can only be called during a `'redirect'` event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "followRedirect(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "followRedirect" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#getHeader:member(1)", "docComment": "/**\n * The value of a previously set extra header name.\n *\n * @param name - The header name.\n *\n * @returns The header value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHeader(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getHeader" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#getUploadProgress:member(1)", "docComment": "/**\n * You can use this method in conjunction with `POST` requests to get the progress of a file upload or other data transfer.\n *\n * @returns The current upload progress.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getUploadProgress(): " }, { "kind": "Reference", "text": "ElectronUploadProgress", "canonicalReference": "obsidian-typings!ElectronUploadProgress:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getUploadProgress" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#on:member(1)", "docComment": "/**\n * Registers a listener for the given request event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ClientRequest` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'abort'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#on:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#on:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#on:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'finish'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#on:member(5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#on:member(6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'redirect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(statusCode: number, method: string, redirectUrl: string, responseHeaders: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string[]>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#on:member(7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'response'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(response: " }, { "kind": "Reference", "text": "ElectronIncomingMessage", "canonicalReference": "obsidian-typings!ElectronIncomingMessage:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the given request event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ClientRequest` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'abort'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#once:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#once:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#once:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'finish'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#once:member(5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#once:member(6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'redirect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(statusCode: number, method: string, redirectUrl: string, responseHeaders: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string[]>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#once:member(7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'response'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(response: " }, { "kind": "Reference", "text": "ElectronIncomingMessage", "canonicalReference": "obsidian-typings!ElectronIncomingMessage:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#removeHeader:member(1)", "docComment": "/**\n * Removes a previously set extra header name. This method can be called only before first write. Trying to call it after the first write will throw an error.\n *\n * @param name - The header name to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeHeader(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeHeader" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#removeListener:member(1)", "docComment": "/**\n * Removes the given listener for the given request event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ClientRequest` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'abort'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#removeListener:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#removeListener:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#removeListener:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'finish'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#removeListener:member(5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#removeListener:member(6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'redirect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(statusCode: number, method: string, redirectUrl: string, responseHeaders: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string[]>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#removeListener:member(7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'response'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(response: " }, { "kind": "Reference", "text": "ElectronIncomingMessage", "canonicalReference": "obsidian-typings!ElectronIncomingMessage:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#setHeader:member(1)", "docComment": "/**\n * Adds an extra HTTP header. The header name will be issued as-is without lowercasing. It can be called only before first write. Calling this method after the first write will throw an error. If the passed value is not a `string`, its `toString()` method will be called to obtain the final value.\n *\n * @param name - The header name.\n *\n * @param value - The header value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHeader(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setHeader" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronClientRequest#write:member(1)", "docComment": "/**\n * Adds a chunk of data to the request body. The first write operation may cause the request headers to be issued on the wire. After the first write operation, it is not allowed to add or remove a custom header.\n *\n * @param chunk - A chunk of request body data.\n *\n * @param encoding - The encoding of `chunk`.\n *\n * @param callback - Invoked after the chunk content has been delivered to the Chromium networking layer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "write(chunk: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", encoding?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "chunk", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "encoding", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "write" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions:interface", "docComment": "/**\n * Options for constructing a `ClientRequest`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronClientRequestConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronClientRequestConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronClientRequestConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#credentials:member", "docComment": "/**\n * Can be `include` or `omit`. Whether to send credentials with this request. If set to `include`, credentials from the session associated with the request will be used. If set to `omit`, credentials will not be sent with the request (and the `'login'` event will not be triggered in the event of a 401). This matches the behavior of the fetch option of the same name. If this option is not specified, authentication data from the session will be sent, and cookies will not be sent (unless `useSessionCookies` is set).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "credentials?: " }, { "kind": "Content", "text": "'include' | 'omit'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "credentials", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#host:member", "docComment": "/**\n * The server host provided as a concatenation of the hostname and the port number `'hostname:port'`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "host?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "host", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#hostname:member", "docComment": "/**\n * The server host name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hostname?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hostname", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#method:member", "docComment": "/**\n * The HTTP request method.\n *\n * @default\n *\n * `'GET'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#origin:member", "docComment": "/**\n * The origin URL of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#partition:member", "docComment": "/**\n * The name of the `partition` with which the request is associated. The `session` option supersedes `partition`. Thus if a `session` is explicitly specified, `partition` is ignored.\n *\n * @default\n *\n * `''`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "partition?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "partition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#path:member", "docComment": "/**\n * The path part of the request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#port:member", "docComment": "/**\n * The server's listening port number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "port?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "port", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#protocol:member", "docComment": "/**\n * Can be `http:` or `https:`. The protocol scheme in the form `'scheme:'`.\n *\n * @default\n *\n * `'http:'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protocol?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "protocol", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#redirect:member", "docComment": "/**\n * Can be `follow`, `error` or `manual`. The redirect mode for this request. When mode is `error`, any redirection will be aborted. When mode is `manual` the redirection will be cancelled unless `request.followRedirect` is invoked synchronously during the `redirect` event.\n *\n * @default\n *\n * `'follow'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redirect?: " }, { "kind": "Content", "text": "'error' | 'follow' | 'manual'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "redirect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#session:member", "docComment": "/**\n * The `Session` instance with which the request is associated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "session?: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#url:member", "docComment": "/**\n * The request URL. Must be provided in the absolute form with the protocol scheme specified as http or https.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions#useSessionCookies:member", "docComment": "/**\n * Whether to send cookies with this request from the provided session. If `credentials` is specified, this option has no effect.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useSessionCookies?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "useSessionCookies", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronClipboard:interface", "docComment": "/**\n * Electron Clipboard for reading and writing system clipboard data.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronClipboard " } ], "fileUrlPath": "src/electron/internals/ElectronClipboard.d.ts", "releaseTag": "Public", "name": "ElectronClipboard", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#availableFormats:member(1)", "docComment": "/**\n * Returns the available clipboard formats.\n *\n * @param type - The clipboard type.\n *\n * @returns An array of format strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "availableFormats(type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "availableFormats" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#clear:member(1)", "docComment": "/**\n * Clears the clipboard content.\n *\n * @param type - The clipboard type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#has:member(1)", "docComment": "/**\n * Returns whether the clipboard has the specified format.\n *\n * @param format - The format to check.\n *\n * @param type - The clipboard type.\n *\n * @returns Whether the format is available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "has(format: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "format", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "has" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#read:member(1)", "docComment": "/**\n * Reads the clipboard content for the specified format.\n *\n * @param format - The format to read.\n *\n * @returns The clipboard content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "read(format: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "format", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "read" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#readBookmark:member(1)", "docComment": "/**\n * Reads the bookmark from the clipboard. Only available on `darwin` and `win32`.\n *\n * @returns The bookmark title and URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readBookmark(): " }, { "kind": "Reference", "text": "ElectronClipboardBookmark", "canonicalReference": "obsidian-typings!ElectronClipboardBookmark:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "readBookmark" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#readBuffer:member(1)", "docComment": "/**\n * Reads the clipboard content as a buffer.\n *\n * @param format - The format to read.\n *\n * @returns The clipboard buffer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readBuffer(format: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "format", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "readBuffer" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#readFindText:member(1)", "docComment": "/**\n * Reads the text on the find pasteboard. Only available on `darwin`.\n *\n * @returns The find pasteboard text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readFindText(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "readFindText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#readHTML:member(1)", "docComment": "/**\n * Reads the clipboard content as HTML.\n *\n * @param type - The clipboard type.\n *\n * @returns The HTML content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readHTML(type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "readHTML" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#readImage:member(1)", "docComment": "/**\n * Reads the clipboard content as a native image.\n *\n * @param type - The clipboard type.\n *\n * @returns The clipboard image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readImage(type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "readImage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#readRTF:member(1)", "docComment": "/**\n * Reads the clipboard content as RTF.\n *\n * @param type - The clipboard type.\n *\n * @returns The RTF content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readRTF(type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "readRTF" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#readText:member(1)", "docComment": "/**\n * Reads the clipboard content as plain text.\n *\n * @param type - The clipboard type.\n *\n * @returns The text content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readText(type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "readText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#write:member(1)", "docComment": "/**\n * Writes data to the clipboard.\n *\n * @param data - The data to write.\n *\n * @param type - The clipboard type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "write(data: " }, { "kind": "Reference", "text": "ElectronData", "canonicalReference": "obsidian-typings!ElectronData:interface" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "write" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#writeBookmark:member(1)", "docComment": "/**\n * Writes a bookmark to the clipboard. The `title` is only used on `darwin`. Only available on `darwin` and `win32`.\n *\n * @param title - The bookmark title.\n *\n * @param url - The bookmark URL.\n *\n * @param type - The clipboard type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeBookmark(title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "writeBookmark" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#writeBuffer:member(1)", "docComment": "/**\n * Writes a buffer to the clipboard as the specified format.\n *\n * @param format - The format to write.\n *\n * @param buffer - The buffer to write.\n *\n * @param type - The clipboard type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeBuffer(format: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", buffer: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "format", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "buffer", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "writeBuffer" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#writeFindText:member(1)", "docComment": "/**\n * Writes text to the find pasteboard as plain text. Only available on `darwin`.\n *\n * @param text - The text to write.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeFindText(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "writeFindText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#writeHTML:member(1)", "docComment": "/**\n * Writes HTML content to the clipboard.\n *\n * @param markup - The HTML content.\n *\n * @param type - The clipboard type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeHTML(markup: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "markup", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "writeHTML" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#writeImage:member(1)", "docComment": "/**\n * Writes a native image to the clipboard.\n *\n * @param image - The image to write.\n *\n * @param type - The clipboard type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeImage(image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "image", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "writeImage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#writeRTF:member(1)", "docComment": "/**\n * Writes text to the clipboard as RTF.\n *\n * @param text - The RTF content.\n *\n * @param type - The clipboard type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeRTF(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "writeRTF" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronClipboard#writeText:member(1)", "docComment": "/**\n * Writes text to the clipboard.\n *\n * @param text - The text to write.\n *\n * @param type - The clipboard type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeText(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "'clipboard' | 'selection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "writeText" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronClipboardBookmark:interface", "docComment": "/**\n * A bookmark read from the clipboard.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronClipboardBookmark " } ], "fileUrlPath": "src/electron/internals/ElectronClipboardBookmark.d.ts", "releaseTag": "Public", "name": "ElectronClipboardBookmark", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClipboardBookmark#title:member", "docComment": "/**\n * The bookmark title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronClipboardBookmark#url:member", "docComment": "/**\n * The bookmark URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCommandLine:interface", "docComment": "/**\n * Reads and manipulates the command line arguments that Chromium uses.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCommandLine " } ], "fileUrlPath": "src/electron/internals/ElectronCommandLine.d.ts", "releaseTag": "Public", "name": "ElectronCommandLine", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCommandLine#appendArgument:member(1)", "docComment": "/**\n * Appends an argument to Chromium's command line. The argument is quoted correctly.\n *\n * @param value - The argument to append.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appendArgument(value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "appendArgument" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCommandLine#appendSwitch:member(1)", "docComment": "/**\n * Appends a switch (with optional value) to Chromium's command line.\n *\n * @param theSwitch - The switch to append.\n *\n * @param value - The optional value for the switch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appendSwitch(theSwitch: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "theSwitch", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "appendSwitch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCommandLine#getSwitchValue:member(1)", "docComment": "/**\n * Returns the value of the given command-line switch.\n *\n * @param theSwitch - The switch to read.\n *\n * @returns The switch value, or an empty string when the switch is absent or has no value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSwitchValue(theSwitch: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "theSwitch", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSwitchValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCommandLine#hasSwitch:member(1)", "docComment": "/**\n * Returns whether the given command-line switch is present.\n *\n * @param theSwitch - The switch to check.\n *\n * @returns Whether the command-line switch is present.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasSwitch(theSwitch: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "theSwitch", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "hasSwitch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCommandLine#removeSwitch:member(1)", "docComment": "/**\n * Removes the specified switch from Chromium's command line.\n *\n * @param theSwitch - The switch to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeSwitch(theSwitch: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "theSwitch", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeSwitch" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronConfig:interface", "docComment": "/**\n * Proxy configuration for a session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronConfig " } ], "fileUrlPath": "src/electron/internals/ElectronConfig.d.ts", "releaseTag": "Public", "name": "ElectronConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronConfig#mode:member", "docComment": "/**\n * The proxy mode. If unspecified, it is determined automatically based on other options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode?: " }, { "kind": "Content", "text": "'auto_detect' | 'direct' | 'fixed_servers' | 'pac_script' | 'system'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronConfig#pacScript:member", "docComment": "/**\n * The URL associated with the PAC file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pacScript?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pacScript", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronConfig#proxyBypassRules:member", "docComment": "/**\n * Rules indicating which URLs should bypass the proxy settings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "proxyBypassRules?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "proxyBypassRules", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronConfig#proxyRules:member", "docComment": "/**\n * Rules indicating which proxies to use.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "proxyRules?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "proxyRules", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronConfigureHostResolverOptions:interface", "docComment": "/**\n * Options for configuring host resolution (DNS and DNS-over-HTTPS).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronConfigureHostResolverOptions " } ], "fileUrlPath": "src/electron/internals/ElectronConfigureHostResolverOptions.d.ts", "releaseTag": "Public", "name": "ElectronConfigureHostResolverOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronConfigureHostResolverOptions#enableAdditionalDnsQueryTypes:member", "docComment": "/**\n * Controls whether additional DNS query types (e.g. HTTPS, DNS type 65) are allowed besides the traditional A and AAAA queries when a request is made via insecure DNS.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableAdditionalDnsQueryTypes?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enableAdditionalDnsQueryTypes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronConfigureHostResolverOptions#enableBuiltInResolver:member", "docComment": "/**\n * Whether the built-in host resolver is used in preference to `getaddrinfo`. Enabled by default on macOS, disabled by default on Windows and Linux.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableBuiltInResolver?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enableBuiltInResolver", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronConfigureHostResolverOptions#secureDnsMode:member", "docComment": "/**\n * Configures the DNS-over-HTTP mode. Can be `off`, `automatic` or `secure`.\n *\n * @default\n *\n * `'automatic'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "secureDnsMode?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "secureDnsMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronConfigureHostResolverOptions#secureDnsServers:member", "docComment": "/**\n * A list of DNS-over-HTTP server templates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "secureDnsServers?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "secureDnsServers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronContentTracing:interface", "docComment": "/**\n * Collects tracing data from Chromium's content module for finding performance bottlenecks and slow operations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronContentTracing " } ], "fileUrlPath": "src/electron/internals/ElectronContentTracing.d.ts", "releaseTag": "Public", "name": "ElectronContentTracing", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronContentTracing#getCategories:member(1)", "docComment": "/**\n * Get a set of category groups. The category groups can change as new code paths are reached. See also the list of built-in tracing categories.\n *\n * @returns A promise that resolves with an array of category groups once all child processes have acknowledged the `getCategories` request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCategories(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCategories" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronContentTracing#getTraceBufferUsage:member(1)", "docComment": "/**\n * Get the maximum usage across processes of the trace buffer as a percentage of the full state.\n *\n * @returns A promise that resolves with an object containing the `value` and `percentage` of the trace buffer maximum usage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTraceBufferUsage(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronTraceBufferUsageReturnValue", "canonicalReference": "obsidian-typings!ElectronTraceBufferUsageReturnValue:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTraceBufferUsage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronContentTracing#startRecording:member(1)", "docComment": "/**\n * Start recording on all processes.\n *\n * Recording begins immediately locally and asynchronously on child processes as soon as they receive the `EnableRecording` request. If a recording is already running, the promise will be immediately resolved, as only one trace operation can be in progress at a time.\n *\n * @param options - The trace configuration.\n *\n * @returns A promise resolved once all child processes have acknowledged the `startRecording` request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startRecording(options: " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ElectronTraceCategoriesAndOptions", "canonicalReference": "obsidian-typings!ElectronTraceCategoriesAndOptions:interface" }, { "kind": "Content", "text": ") | (" }, { "kind": "Reference", "text": "ElectronTraceConfig", "canonicalReference": "obsidian-typings!ElectronTraceConfig:interface" }, { "kind": "Content", "text": ")" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "startRecording" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronContentTracing#stopRecording:member(1)", "docComment": "/**\n * Stop recording on all processes.\n *\n * Trace data will be written into `resultFilePath`. If `resultFilePath` is empty or not provided, trace data will be written to a temporary file, and the path will be returned in the promise.\n *\n * @param resultFilePath - The path to write the traced data to.\n *\n * @returns A promise that resolves with a path to a file that contains the traced data once all child processes have acknowledged the `stopRecording` request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopRecording(resultFilePath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "resultFilePath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "stopRecording" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronContextBridge:interface", "docComment": "/**\n * Electron ContextBridge for exposing APIs from an isolated preload script to the main world.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronContextBridge " } ], "fileUrlPath": "src/electron/internals/ElectronContextBridge.d.ts", "releaseTag": "Public", "name": "ElectronContextBridge", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronContextBridge#exposeInMainWorld:member(1)", "docComment": "/**\n * Exposes an API to the main world under `window[apiKey]`. The `api` is proxied across the context bridge so that the main world cannot mutate the isolated world's objects.\n *\n * @param apiKey - The key on `window` the `api` is exposed under.\n *\n * @param api - The API object to expose. Modeled as `unknown` (the upstream type is `any`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exposeInMainWorld(apiKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", api: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "apiKey", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "api", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "exposeInMainWorld" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronContextMenuParams:interface", "docComment": "/**\n * Parameters describing the context in which a context menu was invoked.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronContextMenuParams " } ], "fileUrlPath": "src/electron/internals/ElectronContextMenuParams.d.ts", "releaseTag": "Public", "name": "ElectronContextMenuParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#altText:member", "docComment": "/**\n * Alt text of the selection that the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "altText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "altText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#dictionarySuggestions:member", "docComment": "/**\n * Suggested words to replace the `misspelledWord`. Only available when there is a misspelled word and spellchecker is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dictionarySuggestions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dictionarySuggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#editFlags:member", "docComment": "/**\n * Flags indicating whether the renderer can perform the corresponding editing action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editFlags: " }, { "kind": "Reference", "text": "ElectronEditFlags", "canonicalReference": "obsidian-typings!ElectronEditFlags:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "editFlags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#frame:member", "docComment": "/**\n * Frame from which the context menu was invoked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#frameCharset:member", "docComment": "/**\n * The character encoding of the frame on which the menu was invoked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frameCharset: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frameCharset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#frameURL:member", "docComment": "/**\n * URL of the subframe that the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frameURL: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frameURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#hasImageContents:member", "docComment": "/**\n * Whether the context menu was invoked on an image which has non-empty contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasImageContents: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hasImageContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#inputFieldType:member", "docComment": "/**\n * If the context menu was invoked on an input field, the type of that field.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputFieldType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputFieldType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#isEditable:member", "docComment": "/**\n * Whether the context is editable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEditable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isEditable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#linkText:member", "docComment": "/**\n * Text associated with the link. May be an empty string if the contents of the link are an image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linkText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "linkText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#linkURL:member", "docComment": "/**\n * URL of the link that encloses the node the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linkURL: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "linkURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#mediaFlags:member", "docComment": "/**\n * The flags for the media element the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mediaFlags: " }, { "kind": "Reference", "text": "ElectronMediaFlags", "canonicalReference": "obsidian-typings!ElectronMediaFlags:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mediaFlags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#mediaType:member", "docComment": "/**\n * Type of the node the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mediaType: " }, { "kind": "Content", "text": "'audio' | 'canvas' | 'file' | 'image' | 'none' | 'plugin' | 'video'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mediaType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#menuSourceType:member", "docComment": "/**\n * Input source that invoked the context menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "menuSourceType: " }, { "kind": "Content", "text": "'adjustSelection' | 'adjustSelectionReset' | 'keyboard' | 'longPress' | 'longTap' | 'mouse' | 'none' | 'stylus' | 'touch' | 'touchHandle' | 'touchMenu'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "menuSourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#misspelledWord:member", "docComment": "/**\n * The misspelled word under the cursor, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "misspelledWord: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "misspelledWord", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#pageURL:member", "docComment": "/**\n * URL of the top level page that the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageURL: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pageURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#referrerPolicy:member", "docComment": "/**\n * The referrer policy of the frame on which the menu is invoked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrerPolicy: " }, { "kind": "Reference", "text": "ElectronReferrer", "canonicalReference": "obsidian-typings!ElectronReferrer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrerPolicy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#selectionRect:member", "docComment": "/**\n * Rect representing the coordinates in the document space of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectionRect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectionRect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#selectionStartOffset:member", "docComment": "/**\n * Start position of the selection text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectionStartOffset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectionStartOffset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#selectionText:member", "docComment": "/**\n * Text of the selection that the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectionText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectionText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#spellcheckEnabled:member", "docComment": "/**\n * Whether spellchecking is enabled, if the context is editable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "spellcheckEnabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "spellcheckEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#srcURL:member", "docComment": "/**\n * Source URL for the element that the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "srcURL: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "srcURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#suggestedFilename:member", "docComment": "/**\n * Suggested filename to be used when saving the file through the 'Save Link As' context menu option.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suggestedFilename: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestedFilename", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#titleText:member", "docComment": "/**\n * Title text of the selection that the context menu was invoked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "titleText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "titleText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#x:member", "docComment": "/**\n * The x coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContextMenuParams#y:member", "docComment": "/**\n * The y coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronContinueActivityDetails:interface", "docComment": "/**\n * Details about a Handoff activity being continued from another device.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronContinueActivityDetails " } ], "fileUrlPath": "src/electron/internals/ElectronContinueActivityDetails.d.ts", "releaseTag": "Public", "name": "ElectronContinueActivityDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronContinueActivityDetails#webpageURL:member", "docComment": "/**\n * A string identifying the URL of the webpage accessed by the activity on another device, if available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webpageURL?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webpageURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCookie:interface", "docComment": "/**\n * A cookie stored in an Electron session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCookie " } ], "fileUrlPath": "src/electron/internals/ElectronCookie.d.ts", "releaseTag": "Public", "name": "ElectronCookie", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#domain:member", "docComment": "/**\n * The domain of the cookie; normalized with a preceding dot so that it is also valid for subdomains.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "domain?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "domain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#expirationDate:member", "docComment": "/**\n * The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "expirationDate?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "expirationDate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#hostOnly:member", "docComment": "/**\n * Whether the cookie is a host-only cookie; this will only be `true` if no domain was passed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hostOnly?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hostOnly", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#httpOnly:member", "docComment": "/**\n * Whether the cookie is marked as HTTP only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "httpOnly?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "httpOnly", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#name:member", "docComment": "/**\n * The name of the cookie.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#path:member", "docComment": "/**\n * The path of the cookie.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#sameSite:member", "docComment": "/**\n * The Same Site policy applied to this cookie.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sameSite: " }, { "kind": "Content", "text": "'lax' | 'no_restriction' | 'strict' | 'unspecified'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sameSite", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#secure:member", "docComment": "/**\n * Whether the cookie is marked as secure.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "secure?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "secure", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#session:member", "docComment": "/**\n * Whether the cookie is a session cookie or a persistent cookie with an expiration date.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "session?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookie#value:member", "docComment": "/**\n * The value of the cookie.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCookies:interface", "docComment": "/**\n * Queries and modifies a session's cookies.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCookies " } ], "fileUrlPath": "src/electron/internals/ElectronCookies.d.ts", "releaseTag": "Public", "name": "ElectronCookies", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCookies#addListener:member(1)", "docComment": "/**\n * Registers a listener for the `changed` event, emitted when a cookie is added, edited, removed, or expired.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the changed cookie, the cause of the change, and whether it was removed.\n *\n * @returns This cookies instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", cookie: " }, { "kind": "Reference", "text": "ElectronCookie", "canonicalReference": "obsidian-typings!ElectronCookie:interface" }, { "kind": "Content", "text": ", cause: 'evicted' | 'expired-overwrite' | 'expired' | 'explicit' | 'overwrite', removed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCookies#flushStore:member(1)", "docComment": "/**\n * Writes any unwritten cookies data to disk.\n *\n * @returns A promise which resolves when the cookie store has been flushed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "flushStore(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "flushStore" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCookies#get:member(1)", "docComment": "/**\n * Sends a request to get all cookies matching `filter`.\n *\n * @param filter - The filter to match cookies against.\n *\n * @returns A promise which resolves to an array of cookie objects.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(filter: " }, { "kind": "Reference", "text": "ElectronCookiesGetFilter", "canonicalReference": "obsidian-typings!ElectronCookiesGetFilter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronCookie", "canonicalReference": "obsidian-typings!ElectronCookie:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCookies#on:member(1)", "docComment": "/**\n * Registers a listener for the `changed` event, emitted when a cookie is added, edited, removed, or expired.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the changed cookie, the cause of the change, and whether it was removed.\n *\n * @returns This cookies instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", cookie: " }, { "kind": "Reference", "text": "ElectronCookie", "canonicalReference": "obsidian-typings!ElectronCookie:interface" }, { "kind": "Content", "text": ", cause: 'evicted' | 'expired-overwrite' | 'expired' | 'explicit' | 'overwrite', removed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCookies#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the changed cookie, the cause of the change, and whether it was removed.\n *\n * @returns This cookies instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", cookie: " }, { "kind": "Reference", "text": "ElectronCookie", "canonicalReference": "obsidian-typings!ElectronCookie:interface" }, { "kind": "Content", "text": ", cause: 'evicted' | 'expired-overwrite' | 'expired' | 'explicit' | 'overwrite', removed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCookies#remove:member(1)", "docComment": "/**\n * Removes the cookies matching `url` and `name`.\n *\n * @param url - The URL associated with the cookie.\n *\n * @param name - The name of the cookie to remove.\n *\n * @returns A promise which resolves when the cookie has been removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "remove" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCookies#removeListener:member(1)", "docComment": "/**\n * Removes the `changed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The previously registered listener to remove.\n *\n * @returns This cookies instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", cookie: " }, { "kind": "Reference", "text": "ElectronCookie", "canonicalReference": "obsidian-typings!ElectronCookie:interface" }, { "kind": "Content", "text": ", cause: 'evicted' | 'expired-overwrite' | 'expired' | 'explicit' | 'overwrite', removed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCookies#set:member(1)", "docComment": "/**\n * Sets a cookie with `details`.\n *\n * @param details - The details of the cookie to set.\n *\n * @returns A promise which resolves when the cookie has been set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "set(details: " }, { "kind": "Reference", "text": "ElectronCookiesSetDetails", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "details", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "set" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCookiesGetFilter:interface", "docComment": "/**\n * Filter used to query cookies from an Electron session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCookiesGetFilter " } ], "fileUrlPath": "src/electron/internals/ElectronCookiesGetFilter.d.ts", "releaseTag": "Public", "name": "ElectronCookiesGetFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesGetFilter#domain:member", "docComment": "/**\n * Retrieves cookies whose domains match or are subdomains of `domains`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "domain?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "domain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesGetFilter#name:member", "docComment": "/**\n * Filters cookies by name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesGetFilter#path:member", "docComment": "/**\n * Retrieves cookies whose path matches `path`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesGetFilter#secure:member", "docComment": "/**\n * Filters cookies by their Secure property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "secure?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "secure", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesGetFilter#session:member", "docComment": "/**\n * Filters out session or persistent cookies.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "session?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesGetFilter#url:member", "docComment": "/**\n * Retrieves cookies which are associated with `url`. Empty implies retrieving cookies of all URLs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails:interface", "docComment": "/**\n * Details used to set a cookie on an Electron session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCookiesSetDetails " } ], "fileUrlPath": "src/electron/internals/ElectronCookiesSetDetails.d.ts", "releaseTag": "Public", "name": "ElectronCookiesSetDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#domain:member", "docComment": "/**\n * The domain of the cookie; normalized with a preceding dot so that it is also valid for subdomains. Empty by default if omitted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "domain?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "domain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#expirationDate:member", "docComment": "/**\n * The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted then the cookie becomes a session cookie and will not be retained between sessions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "expirationDate?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "expirationDate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#httpOnly:member", "docComment": "/**\n * Whether the cookie should be marked as HTTP only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "httpOnly?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "httpOnly", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#name:member", "docComment": "/**\n * The name of the cookie. Empty by default if omitted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#path:member", "docComment": "/**\n * The path of the cookie. Empty by default if omitted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#sameSite:member", "docComment": "/**\n * The Same Site policy to apply to this cookie.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sameSite?: " }, { "kind": "Content", "text": "'lax' | 'no_restriction' | 'strict' | 'unspecified'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sameSite", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#secure:member", "docComment": "/**\n * Whether the cookie should be marked as Secure.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "secure?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "secure", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#url:member", "docComment": "/**\n * The URL to associate the cookie with. The promise will be rejected if the URL is invalid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCookiesSetDetails#value:member", "docComment": "/**\n * The value of the cookie. Empty by default if omitted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCPUUsage:interface", "docComment": "/**\n * CPU usage statistics for a process.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCPUUsage " } ], "fileUrlPath": "src/electron/internals/ElectronCPUUsage.d.ts", "releaseTag": "Public", "name": "ElectronCPUUsage", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCPUUsage#idleWakeupsPerSecond:member", "docComment": "/**\n * The number of average idle CPU wakeups per second since the last call to `getCPUUsage`. First call returns `0`. Always returns `0` on Windows.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "idleWakeupsPerSecond: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "idleWakeupsPerSecond", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCPUUsage#percentCPUUsage:member", "docComment": "/**\n * Percentage of CPU used since the last call to `getCPUUsage`. First call returns `0`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "percentCPUUsage: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "percentCPUUsage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCrashReport:interface", "docComment": "/**\n * The date and ID of a crash report.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCrashReport " } ], "fileUrlPath": "src/electron/internals/ElectronCrashReport.d.ts", "releaseTag": "Public", "name": "ElectronCrashReport", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReport#date:member", "docComment": "/**\n * The date the crash report was created.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "date: " }, { "kind": "Reference", "text": "Date", "canonicalReference": "!Date:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "date", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReport#id:member", "docComment": "/**\n * The uploaded ID of the crash report.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCrashReporter:interface", "docComment": "/**\n * Electron CrashReporter for submitting crash reports to a remote server.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCrashReporter " } ], "fileUrlPath": "src/electron/internals/ElectronCrashReporter.d.ts", "releaseTag": "Public", "name": "ElectronCrashReporter", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCrashReporter#addExtraParameter:member(1)", "docComment": "/**\n * Sets an extra parameter to be sent with the crash report. The values specified here will be sent in addition to any values set via the `extra` option when `start` was called. Parameters added in this fashion are specific to the calling process.\n *\n * @param key - The parameter key. Must be no longer than 39 bytes.\n *\n * @param value - The parameter value. Must be no longer than 20320 bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addExtraParameter(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addExtraParameter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCrashReporter#getLastCrashReport:member(1)", "docComment": "/**\n * Returns the date and ID of the last crash report. Only crash reports that have been uploaded will be returned; even if a crash report is present on disk it will not be returned until it is uploaded.\n *\n * @returns The last uploaded crash report, or `null` if there are no uploaded reports.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLastCrashReport(): " }, { "kind": "Reference", "text": "ElectronCrashReport", "canonicalReference": "obsidian-typings!ElectronCrashReport:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLastCrashReport" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCrashReporter#getParameters:member(1)", "docComment": "/**\n * Returns the current `extra` parameters of the crash reporter.\n *\n * @returns The current `extra` parameters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getParameters(): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getParameters" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCrashReporter#getUploadedReports:member(1)", "docComment": "/**\n * Returns all uploaded crash reports. Each report contains the date and uploaded ID.\n *\n * @returns The uploaded crash reports.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getUploadedReports(): " }, { "kind": "Reference", "text": "ElectronCrashReport", "canonicalReference": "obsidian-typings!ElectronCrashReport:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getUploadedReports" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCrashReporter#getUploadToServer:member(1)", "docComment": "/**\n * Returns whether reports should be submitted to the server. Set through the `start` method or `setUploadToServer`.\n *\n * @returns Whether reports should be submitted to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getUploadToServer(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getUploadToServer" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCrashReporter#removeExtraParameter:member(1)", "docComment": "/**\n * Removes an extra parameter from the current set of parameters. Future crashes will not include this parameter.\n *\n * @param key - The parameter key to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeExtraParameter(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeExtraParameter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCrashReporter#setUploadToServer:member(1)", "docComment": "/**\n * Sets whether reports should be submitted to the server. This would normally be controlled by user preferences. This has no effect if called before `start` is called.\n *\n * @param uploadToServer - Whether reports should be submitted to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUploadToServer(uploadToServer: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "uploadToServer", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setUploadToServer" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronCrashReporter#start:member(1)", "docComment": "/**\n * Initializes the crash reporter. This method must be called before using any other `crashReporter` APIs. Once initialized, the crashpad handler collects crashes from all subsequently created processes.\n *\n * @param options - The crash reporter options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start(options: " }, { "kind": "Reference", "text": "ElectronCrashReporterStartOptions", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "start" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions:interface", "docComment": "/**\n * Options for `crashReporter.start`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCrashReporterStartOptions " } ], "fileUrlPath": "src/electron/internals/ElectronCrashReporterStartOptions.d.ts", "releaseTag": "Public", "name": "ElectronCrashReporterStartOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#companyName:member", "docComment": "/**\n * Deprecated alias for `{ globalExtra: { _companyName: ... } }`.\n *\n * @deprecated\n *\n * Deprecated by Electron.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "companyName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "companyName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#compress:member", "docComment": "/**\n * If `true`, crash reports will be compressed and uploaded with `Content-Encoding: gzip`.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compress?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "compress", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#extra:member", "docComment": "/**\n * Extra string key/value annotations that will be sent along with crash reports that are generated in the main process. Only string values are supported. Crashes generated in child processes will not contain these extra parameters to crash reports generated from child processes, call `addExtraParameter` from the child process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extra?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "extra", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#globalExtra:member", "docComment": "/**\n * Extra string key/value annotations that will be sent along with any crash reports generated in any process. These annotations cannot be changed once the crash reporter has been started. If a key is present in both the global extra parameters and the process-specific extra parameters, then the global one will take precedence. By default, `productName` and the app version are included, as well as the Electron version.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "globalExtra?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "globalExtra", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#ignoreSystemCrashHandler:member", "docComment": "/**\n * If `true`, crashes generated in the main process will not be forwarded to the system crash handler.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ignoreSystemCrashHandler?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ignoreSystemCrashHandler", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#productName:member", "docComment": "/**\n * The name of the product, defaulting to `app.name`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "productName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "productName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#rateLimit:member", "docComment": "/**\n * If `true`, limit the number of crashes uploaded to 1/hour.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rateLimit?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rateLimit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#submitURL:member", "docComment": "/**\n * URL that crash reports will be sent to as POST. Required unless `uploadToServer` is `false`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "submitURL?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "submitURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCrashReporterStartOptions#uploadToServer:member", "docComment": "/**\n * Whether crash reports should be sent to the server. If `false`, crash reports will be collected and stored in the crashes directory, but not uploaded.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uploadToServer?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "uploadToServer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCreateFromBitmapOptions:interface", "docComment": "/**\n * Options for `nativeImage.createFromBitmap`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCreateFromBitmapOptions " } ], "fileUrlPath": "src/electron/internals/ElectronCreateFromBitmapOptions.d.ts", "releaseTag": "Public", "name": "ElectronCreateFromBitmapOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateFromBitmapOptions#height:member", "docComment": "/**\n * The height of the bitmap, in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateFromBitmapOptions#scaleFactor:member", "docComment": "/**\n * The scale factor of the bitmap.\n *\n * @default\n *\n * `1`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateFromBitmapOptions#width:member", "docComment": "/**\n * The width of the bitmap, in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCreateFromBufferOptions:interface", "docComment": "/**\n * Options for `nativeImage.createFromBuffer`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCreateFromBufferOptions " } ], "fileUrlPath": "src/electron/internals/ElectronCreateFromBufferOptions.d.ts", "releaseTag": "Public", "name": "ElectronCreateFromBufferOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateFromBufferOptions#height:member", "docComment": "/**\n * Required for bitmap buffers. The height of the image, in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateFromBufferOptions#scaleFactor:member", "docComment": "/**\n * The scale factor of the image.\n *\n * @default\n *\n * `1`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateFromBufferOptions#width:member", "docComment": "/**\n * Required for bitmap buffers. The width of the image, in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions:interface", "docComment": "/**\n * Options used to resume a cancelled or interrupted download from a previous session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCreateInterruptedDownloadOptions " } ], "fileUrlPath": "src/electron/internals/ElectronCreateInterruptedDownloadOptions.d.ts", "releaseTag": "Public", "name": "ElectronCreateInterruptedDownloadOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions#eTag:member", "docComment": "/**\n * ETag header value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eTag?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "eTag", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions#lastModified:member", "docComment": "/**\n * Last-Modified header value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastModified?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lastModified", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions#length:member", "docComment": "/**\n * Total length of the download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions#mimeType:member", "docComment": "/**\n * The MIME type of the download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mimeType?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mimeType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions#offset:member", "docComment": "/**\n * Start range for the download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions#path:member", "docComment": "/**\n * Absolute path of the download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions#startTime:member", "docComment": "/**\n * Time when the download was started in number of seconds since the UNIX epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startTime?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "startTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions#urlChain:member", "docComment": "/**\n * Complete URL chain for the download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "urlChain: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "urlChain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronCustomScheme:interface", "docComment": "/**\n * A custom scheme to be registered with a protocol, along with its privileges.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronCustomScheme " } ], "fileUrlPath": "src/electron/internals/ElectronCustomScheme.d.ts", "releaseTag": "Public", "name": "ElectronCustomScheme", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCustomScheme#privileges:member", "docComment": "/**\n * The privileges to grant to the scheme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "privileges?: " }, { "kind": "Reference", "text": "ElectronPrivileges", "canonicalReference": "obsidian-typings!ElectronPrivileges:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "privileges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronCustomScheme#scheme:member", "docComment": "/**\n * Custom scheme to be registered with options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scheme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronData:interface", "docComment": "/**\n * Data to write to the clipboard.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronData " } ], "fileUrlPath": "src/electron/internals/ElectronData.d.ts", "releaseTag": "Public", "name": "ElectronData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronData#bookmark:member", "docComment": "/**\n * The title of the URL at `text`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bookmark?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "bookmark", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronData#html:member", "docComment": "/**\n * The HTML markup content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "html?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "html", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronData#image:member", "docComment": "/**\n * The image content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "image?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "image", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronData#rtf:member", "docComment": "/**\n * The RTF content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rtf?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rtf", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronData#text:member", "docComment": "/**\n * The plain text content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDebugger:interface", "docComment": "/**\n * A debugger instance for a web contents, used to communicate with the Chrome DevTools Protocol.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDebugger " } ], "fileUrlPath": "src/electron/internals/ElectronDebugger.d.ts", "releaseTag": "Public", "name": "ElectronDebugger", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#addListener:member(1)", "docComment": "/**\n * Registers a listener for the `detach` event, emitted when the debugging session is terminated.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the event and the reason for detaching.\n *\n * @returns This debugger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'detach'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", reason: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#addListener:member(2)", "docComment": "/**\n * Registers a listener for the `message` event, emitted when the debugging target issues an instrumentation event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the event, method name, event parameters, and session id.\n *\n * @returns This debugger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", method: string, params: unknown, sessionId: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#attach:member(1)", "docComment": "/**\n * Attaches the debugger to the web contents.\n *\n * @param protocolVersion - The requested debugging protocol version.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attach(protocolVersion?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "protocolVersion", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "attach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#detach:member(1)", "docComment": "/**\n * Detaches the debugger from the web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detach(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "detach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#isAttached:member(1)", "docComment": "/**\n * Returns whether a debugger is attached to the web contents.\n *\n * @returns Whether a debugger is attached.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAttached(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isAttached" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#on:member(1)", "docComment": "/**\n * Registers a listener for the `detach` event, emitted when the debugging session is terminated.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the event and the reason for detaching.\n *\n * @returns This debugger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'detach'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", reason: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#on:member(2)", "docComment": "/**\n * Registers a listener for the `message` event, emitted when the debugging target issues an instrumentation event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the event, method name, event parameters, and session id.\n *\n * @returns This debugger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", method: string, params: unknown, sessionId: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `detach` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the event and the reason for detaching.\n *\n * @returns This debugger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'detach'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", reason: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the event, method name, event parameters, and session id.\n *\n * @returns This debugger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", method: string, params: unknown, sessionId: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#removeListener:member(1)", "docComment": "/**\n * Removes a previously registered `detach` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This debugger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'detach'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", reason: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#removeListener:member(2)", "docComment": "/**\n * Removes a previously registered `message` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This debugger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", method: string, params: unknown, sessionId: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDebugger#sendCommand:member(1)", "docComment": "/**\n * Sends a given command to the debugging target.\n *\n * @param method - The command method name.\n *\n * @param commandParams - The parameters required by the command.\n *\n * @param sessionId - The session id for the command.\n *\n * @returns A promise resolving with the command response.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendCommand(method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", commandParams?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", sessionId?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "method", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "commandParams", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "sessionId", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "sendCommand" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDefaultFontFamily:interface", "docComment": "/**\n * Default font families used by the renderer, keyed by generic family.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDefaultFontFamily " } ], "fileUrlPath": "src/electron/internals/ElectronDefaultFontFamily.d.ts", "releaseTag": "Public", "name": "ElectronDefaultFontFamily", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDefaultFontFamily#cursive:member", "docComment": "/**\n * The cursive font family.\n *\n * @default\n *\n * `Script`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursive?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cursive", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDefaultFontFamily#fantasy:member", "docComment": "/**\n * The fantasy font family.\n *\n * @default\n *\n * `Impact`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fantasy?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fantasy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDefaultFontFamily#monospace:member", "docComment": "/**\n * The monospace font family.\n *\n * @default\n *\n * `Courier New`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "monospace?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "monospace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDefaultFontFamily#sansSerif:member", "docComment": "/**\n * The sans-serif font family.\n *\n * @default\n *\n * `Arial`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sansSerif?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sansSerif", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDefaultFontFamily#serif:member", "docComment": "/**\n * The serif font family.\n *\n * @default\n *\n * `Times New Roman`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serif?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "serif", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDefaultFontFamily#standard:member", "docComment": "/**\n * The standard font family.\n *\n * @default\n *\n * `Times New Roman`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "standard?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "standard", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDesktopCapturer:interface", "docComment": "/**\n * Electron desktop capturer for accessing information about media sources that can be used to capture audio and video from the desktop using the `navigator.mediaDevices.getUserMedia` API.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDesktopCapturer " } ], "fileUrlPath": "src/electron/internals/ElectronDesktopCapturer.d.ts", "releaseTag": "Public", "name": "ElectronDesktopCapturer", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDesktopCapturer#getSources:member(1)", "docComment": "/**\n * Resolves with an array of `DesktopCapturerSource` objects, each representing a screen or an individual window that can be captured.\n *\n * Capturing the screen contents requires user consent on macOS 10.15 Catalina or higher, which can be detected via `systemPreferences.getMediaAccessStatus`.\n *\n * @param options - Options describing which sources to capture.\n *\n * @returns A promise resolving with the captured sources.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSources(options: " }, { "kind": "Reference", "text": "ElectronSourcesOptions", "canonicalReference": "obsidian-typings!ElectronSourcesOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronDesktopCapturerSource", "canonicalReference": "obsidian-typings!ElectronDesktopCapturerSource:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSources" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDesktopCapturerSource:interface", "docComment": "/**\n * A screen or individual window that can be captured, returned by `desktopCapturer.getSources`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDesktopCapturerSource " } ], "fileUrlPath": "src/electron/internals/ElectronDesktopCapturerSource.d.ts", "releaseTag": "Public", "name": "ElectronDesktopCapturerSource", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDesktopCapturerSource#appIcon:member", "docComment": "/**\n * An icon image of the application that owns the window, or `null` if the source has a type screen. The size of the icon is not known in advance and depends on what the application provides.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appIcon: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "appIcon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDesktopCapturerSource#display_id:member", "docComment": "/**\n * A unique identifier that corresponds to the `id` of the matching display returned by the Screen API. On some platforms, this is equivalent to the `XX` portion of the `id` field above and on others it differs. It is an empty string if not available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "display_id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "display_id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDesktopCapturerSource#id:member", "docComment": "/**\n * The identifier of a window or screen that can be used as a `chromeMediaSourceId` constraint when calling `navigator.webkitGetUserMedia`. The format of the identifier is `window:XX:YY` or `screen:ZZ:0`. `XX` is the windowID/handle, `YY` is `1` for the current process and `0` for all others, and `ZZ` is a sequential number representing the screen.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDesktopCapturerSource#name:member", "docComment": "/**\n * A screen source is named either `Entire Screen` or `Screen <index>`, while the name of a window source matches the window title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDesktopCapturerSource#thumbnail:member", "docComment": "/**\n * A thumbnail image. There is no guarantee that the size of the thumbnail matches the `thumbnailSize` specified in the `options` passed to `desktopCapturer.getSources`. The actual size depends on the scale of the screen or window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "thumbnail: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "thumbnail", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDetails:interface", "docComment": "/**\n * Details about a child process that has gone (crashed or killed).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDetails " } ], "fileUrlPath": "src/electron/internals/ElectronDetails.d.ts", "releaseTag": "Public", "name": "ElectronDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDetails#exitCode:member", "docComment": "/**\n * The exit code for the process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exitCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "exitCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDetails#name:member", "docComment": "/**\n * The name of the process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDetails#reason:member", "docComment": "/**\n * The reason the child process is gone.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reason: " }, { "kind": "Content", "text": "'abnormal-exit' | 'clean-exit' | 'crashed' | 'integrity-failure' | 'killed' | 'launch-failed' | 'oom'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "reason", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDetails#serviceName:member", "docComment": "/**\n * The non-localized name of the process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serviceName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "serviceName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDetails#type:member", "docComment": "/**\n * Process type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'GPU' | 'Pepper Plugin' | 'Pepper Plugin Broker' | 'Sandbox helper' | 'Unknown' | 'Utility' | 'Zygote'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDevicePermissionHandlerHandlerDetails:interface", "docComment": "/**\n * Details passed to a device permission handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDevicePermissionHandlerHandlerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronDevicePermissionHandlerHandlerDetails.d.ts", "releaseTag": "Public", "name": "ElectronDevicePermissionHandlerHandlerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDevicePermissionHandlerHandlerDetails#device:member", "docComment": "/**\n * The device that permission is being requested for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "device: " }, { "kind": "Reference", "text": "ElectronHIDDevice", "canonicalReference": "obsidian-typings!ElectronHIDDevice:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "device", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDevicePermissionHandlerHandlerDetails#deviceType:member", "docComment": "/**\n * The type of device that permission is being requested on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceType: " }, { "kind": "Content", "text": "'hid' | 'serial'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deviceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDevicePermissionHandlerHandlerDetails#frame:member", "docComment": "/**\n * The frame checking the device permission.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDevicePermissionHandlerHandlerDetails#origin:member", "docComment": "/**\n * The origin URL of the device permission check.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "origin: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDialog:interface", "docComment": "/**\n * Electron Dialog for showing native system dialogs.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDialog " } ], "fileUrlPath": "src/electron/internals/ElectronDialog.d.ts", "releaseTag": "Public", "name": "ElectronDialog", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showCertificateTrustDialog:member(1)", "docComment": "/**\n * Shows a certificate trust dialog (macOS, Windows only).\n *\n * @param browserWindow - The parent window the dialog attaches to.\n *\n * @param options - The certificate trust dialog options.\n *\n * @returns A `Promise` that resolves when the certificate trust dialog is shown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showCertificateTrustDialog(browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronCertificateTrustDialogOptions", "canonicalReference": "obsidian-typings!ElectronCertificateTrustDialogOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showCertificateTrustDialog" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showCertificateTrustDialog:member(2)", "docComment": "/**\n * Shows a certificate trust dialog (macOS, Windows only).\n *\n * @param options - The certificate trust dialog options.\n *\n * @returns A `Promise` that resolves when the certificate trust dialog is shown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showCertificateTrustDialog(options: " }, { "kind": "Reference", "text": "ElectronCertificateTrustDialogOptions", "canonicalReference": "obsidian-typings!ElectronCertificateTrustDialogOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showCertificateTrustDialog" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showErrorBox:member(1)", "docComment": "/**\n * Shows an error message box.\n *\n * @param title - The dialog title.\n *\n * @param content - The error message content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showErrorBox(title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showErrorBox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showMessageBox:member(1)", "docComment": "/**\n * Shows a message box dialog.\n *\n * @param browserWindow - The parent window.\n *\n * @param options - The message box options.\n *\n * @returns The user's response.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMessageBox(browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronMessageBoxOptions", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronMessageBoxReturnValue", "canonicalReference": "obsidian-typings!ElectronMessageBoxReturnValue:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showMessageBox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showMessageBox:member(2)", "docComment": "/**\n * Shows a message box dialog.\n *\n * @param options - The message box options.\n *\n * @returns The user's response.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMessageBox(options: " }, { "kind": "Reference", "text": "ElectronMessageBoxOptions", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronMessageBoxReturnValue", "canonicalReference": "obsidian-typings!ElectronMessageBoxReturnValue:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showMessageBox" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showMessageBoxSync:member(1)", "docComment": "/**\n * Shows a message box dialog, blocking the process until it is closed.\n *\n * @param browserWindow - The parent window.\n *\n * @param options - The message box options.\n *\n * @returns The index of the clicked button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMessageBoxSync(browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronMessageBoxSyncOptions", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showMessageBoxSync" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showMessageBoxSync:member(2)", "docComment": "/**\n * Shows a message box dialog, blocking the process until it is closed.\n *\n * @param options - The message box options.\n *\n * @returns The index of the clicked button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMessageBoxSync(options: " }, { "kind": "Reference", "text": "ElectronMessageBoxSyncOptions", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showMessageBoxSync" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showOpenDialog:member(1)", "docComment": "/**\n * Shows an open file dialog.\n *\n * @param browserWindow - The parent window.\n *\n * @param options - The open dialog options.\n *\n * @returns The selected file paths.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showOpenDialog(browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronOpenDialogOptions", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronOpenDialogReturnValue", "canonicalReference": "obsidian-typings!ElectronOpenDialogReturnValue:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showOpenDialog" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showOpenDialog:member(2)", "docComment": "/**\n * Shows an open file dialog.\n *\n * @param options - The open dialog options.\n *\n * @returns The selected file paths.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showOpenDialog(options: " }, { "kind": "Reference", "text": "ElectronOpenDialogOptions", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronOpenDialogReturnValue", "canonicalReference": "obsidian-typings!ElectronOpenDialogReturnValue:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showOpenDialog" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showOpenDialogSync:member(1)", "docComment": "/**\n * Shows an open file dialog, blocking the process until it is closed.\n *\n * @param browserWindow - The parent window.\n *\n * @param options - The open dialog options.\n *\n * @returns The file paths chosen by the user, or `undefined` if the dialog is cancelled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showOpenDialogSync(browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronOpenDialogSyncOptions", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string[] | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showOpenDialogSync" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showOpenDialogSync:member(2)", "docComment": "/**\n * Shows an open file dialog, blocking the process until it is closed.\n *\n * @param options - The open dialog options.\n *\n * @returns The file paths chosen by the user, or `undefined` if the dialog is cancelled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showOpenDialogSync(options: " }, { "kind": "Reference", "text": "ElectronOpenDialogSyncOptions", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string[] | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showOpenDialogSync" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showSaveDialog:member(1)", "docComment": "/**\n * Shows a save file dialog.\n *\n * @param browserWindow - The parent window.\n *\n * @param options - The save dialog options.\n *\n * @returns The selected file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSaveDialog(browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronSaveDialogOptions", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronSaveDialogReturnValue", "canonicalReference": "obsidian-typings!ElectronSaveDialogReturnValue:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showSaveDialog" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showSaveDialog:member(2)", "docComment": "/**\n * Shows a save file dialog.\n *\n * @param options - The save dialog options.\n *\n * @returns The selected file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSaveDialog(options: " }, { "kind": "Reference", "text": "ElectronSaveDialogOptions", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronSaveDialogReturnValue", "canonicalReference": "obsidian-typings!ElectronSaveDialogReturnValue:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showSaveDialog" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showSaveDialogSync:member(1)", "docComment": "/**\n * Shows a save file dialog, blocking the process until it is closed.\n *\n * @param browserWindow - The parent window.\n *\n * @param options - The save dialog options.\n *\n * @returns The path of the file chosen by the user, or `undefined` if the dialog is cancelled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSaveDialogSync(browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronSaveDialogSyncOptions", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showSaveDialogSync" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDialog#showSaveDialogSync:member(2)", "docComment": "/**\n * Shows a save file dialog, blocking the process until it is closed.\n *\n * @param options - The save dialog options.\n *\n * @returns The path of the file chosen by the user, or `undefined` if the dialog is cancelled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSaveDialogSync(options: " }, { "kind": "Reference", "text": "ElectronSaveDialogSyncOptions", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showSaveDialogSync" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails:interface", "docComment": "/**\n * Details about a window created via `window.open`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDidCreateWindowDetails " } ], "fileUrlPath": "src/electron/internals/ElectronDidCreateWindowDetails.d.ts", "releaseTag": "Public", "name": "ElectronDidCreateWindowDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails#disposition:member", "docComment": "/**\n * The disposition used when creating the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disposition: " }, { "kind": "Content", "text": "'background-tab' | 'default' | 'foreground-tab' | 'new-window' | 'other' | 'save-to-disk'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disposition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails#frameName:member", "docComment": "/**\n * Name given to the created window in the `window.open()` call.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frameName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frameName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails#options:member", "docComment": "/**\n * The options used to create the BrowserWindow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "BrowserWindowConstructorOptions", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails#postBody:member", "docComment": "/**\n * The post data that will be sent to the new window, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postBody?: " }, { "kind": "Reference", "text": "ElectronPostBody", "canonicalReference": "obsidian-typings!ElectronPostBody:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "postBody", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails#referrer:member", "docComment": "/**\n * The referrer that will be passed to the new window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Reference", "text": "ElectronReferrer", "canonicalReference": "obsidian-typings!ElectronReferrer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails#url:member", "docComment": "/**\n * URL for the created window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDisplay:interface", "docComment": "/**\n * Describes a display connected to the system.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDisplay " } ], "fileUrlPath": "src/electron/internals/ElectronDisplay.d.ts", "releaseTag": "Public", "name": "ElectronDisplay", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#accelerometerSupport:member", "docComment": "/**\n * Whether the display supports accelerometer input. Can be `available`, `unavailable` or `unknown`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accelerometerSupport: " }, { "kind": "Content", "text": "'available' | 'unavailable' | 'unknown'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "accelerometerSupport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#bounds:member", "docComment": "/**\n * The bounds of the display in DIP points.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bounds", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#colorDepth:member", "docComment": "/**\n * The number of bits per pixel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "colorDepth: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "colorDepth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#colorSpace:member", "docComment": "/**\n * Represents a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "colorSpace: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "colorSpace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#depthPerComponent:member", "docComment": "/**\n * The number of bits per color component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "depthPerComponent: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "depthPerComponent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#displayFrequency:member", "docComment": "/**\n * The display refresh rate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayFrequency: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "displayFrequency", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#id:member", "docComment": "/**\n * Unique identifier associated with the display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#internal:member", "docComment": "/**\n * `true` for an internal display and `false` for an external display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "internal: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "internal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#monochrome:member", "docComment": "/**\n * Whether or not the display is a monochrome display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "monochrome: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "monochrome", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#rotation:member", "docComment": "/**\n * Screen rotation in clock-wise degrees. Can be `0`, `90`, `180` or `270`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rotation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#scaleFactor:member", "docComment": "/**\n * Output device's pixel scale factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleFactor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#size:member", "docComment": "/**\n * The size of the display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "size", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#touchSupport:member", "docComment": "/**\n * Whether the display supports touch input. Can be `available`, `unavailable` or `unknown`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "touchSupport: " }, { "kind": "Content", "text": "'available' | 'unavailable' | 'unknown'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "touchSupport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#workArea:member", "docComment": "/**\n * The work area of the display in DIP points.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workArea: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "workArea", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplay#workAreaSize:member", "docComment": "/**\n * The size of the work area of the display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workAreaSize: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "workAreaSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions:interface", "docComment": "/**\n * Options for {@link ElectronTray.displayBalloon}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDisplayBalloonOptions " } ], "fileUrlPath": "src/electron/internals/ElectronDisplayBalloonOptions.d.ts", "releaseTag": "Public", "name": "ElectronDisplayBalloonOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions#content:member", "docComment": "/**\n * The content of the balloon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions#icon:member", "docComment": "/**\n * Icon to use when `iconType` is `custom`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions#iconType:member", "docComment": "/**\n * Can be `none`, `info`, `warning`, `error` or `custom`.\n *\n * @default\n *\n * `custom`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconType?: " }, { "kind": "Content", "text": "'custom' | 'error' | 'info' | 'none' | 'warning'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "iconType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions#largeIcon:member", "docComment": "/**\n * The large version of the icon should be used. Maps to `NIIF_LARGE_ICON`.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "largeIcon?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "largeIcon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions#noSound:member", "docComment": "/**\n * Do not play the associated sound. Maps to `NIIF_NOSOUND`.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "noSound?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "noSound", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions#respectQuietTime:member", "docComment": "/**\n * Do not display the balloon notification if the current user is in \"quiet time\". Maps to `NIIF_RESPECT_QUIET_TIME`.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "respectQuietTime?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "respectQuietTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions#title:member", "docComment": "/**\n * The title of the balloon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDock:interface", "docComment": "/**\n * Performs actions on the app icon in the user's dock on macOS.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDock " } ], "fileUrlPath": "src/electron/internals/ElectronDock.d.ts", "releaseTag": "Public", "name": "ElectronDock", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#bounce:member(1)", "docComment": "/**\n * Bounces the dock icon. When `critical` is passed, the icon bounces until the app becomes active or the request is canceled; when `informational` is passed, it bounces for one second. macOS only.\n *\n * @param type - The bounce type.\n *\n * @returns An ID representing the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bounce(type?: " }, { "kind": "Content", "text": "'critical' | 'informational'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "bounce" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#cancelBounce:member(1)", "docComment": "/**\n * Cancels the bounce of the given request. macOS only.\n *\n * @param id - The bounce request ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancelBounce(id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "cancelBounce" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#downloadFinished:member(1)", "docComment": "/**\n * Bounces the Downloads stack if the file path is inside the Downloads folder. macOS only.\n *\n * @param filePath - The path of the finished download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadFinished(filePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filePath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "downloadFinished" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#getBadge:member(1)", "docComment": "/**\n * Returns the badge string of the dock. macOS only.\n *\n * @returns The badge string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBadge(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBadge" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#getMenu:member(1)", "docComment": "/**\n * Returns the application's dock menu. macOS only.\n *\n * @returns The dock menu, or `null` if none has been set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMenu(): " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#hide:member(1)", "docComment": "/**\n * Hides the dock icon. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hide(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hide" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#isVisible:member(1)", "docComment": "/**\n * Returns whether the dock icon is visible. macOS only.\n *\n * @returns Whether the dock icon is visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isVisible(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isVisible" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#setBadge:member(1)", "docComment": "/**\n * Sets the string to be displayed in the dock's badging area. macOS only.\n *\n * @param text - The badge text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBadge(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setBadge" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#setIcon:member(1)", "docComment": "/**\n * Sets the image associated with this dock icon. macOS only.\n *\n * @param image - The image, or a path to it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIcon(image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "image", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "setIcon" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#setMenu:member(1)", "docComment": "/**\n * Sets the application's dock menu. macOS only.\n *\n * @param menu - The menu to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMenu(menu: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDock#show:member(1)", "docComment": "/**\n * Shows the dock icon. macOS only.\n *\n * @returns A promise resolved when the dock icon is shown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "show(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "show" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronDownloadItem:interface", "docComment": "/**\n * Controls and reports on a file download in a session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronDownloadItem " } ], "fileUrlPath": "src/electron/internals/ElectronDownloadItem.d.ts", "releaseTag": "Public", "name": "ElectronDownloadItem", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#addListener:member(1)", "docComment": "/**\n * Registers a listener for the `done` event, emitted when the download reaches a terminal state.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the terminal state of the download.\n *\n * @returns This download item instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'done'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", state: 'cancelled' | 'completed' | 'interrupted') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#addListener:member(2)", "docComment": "/**\n * Registers a listener for the `updated` event, emitted when the download has been updated and is not done.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the current state of the download.\n *\n * @returns This download item instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", state: 'interrupted' | 'progressing') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#cancel:member(1)", "docComment": "/**\n * Cancels the download operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cancel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#canResume:member(1)", "docComment": "/**\n * Returns whether the download can resume.\n *\n * @returns Whether the download can resume.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canResume(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canResume" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getContentDisposition:member(1)", "docComment": "/**\n * Returns the `Content-Disposition` field from the response header.\n *\n * @returns The content disposition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getContentDisposition(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getContentDisposition" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getETag:member(1)", "docComment": "/**\n * Returns the `ETag` header value.\n *\n * @returns The ETag value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getETag(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getETag" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getFilename:member(1)", "docComment": "/**\n * Returns the file name of the download item.\n *\n * @returns The file name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFilename(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFilename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getLastModifiedTime:member(1)", "docComment": "/**\n * Returns the `Last-Modified` header value.\n *\n * @returns The last modified time.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLastModifiedTime(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLastModifiedTime" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getMimeType:member(1)", "docComment": "/**\n * Returns the file's MIME type.\n *\n * @returns The MIME type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMimeType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMimeType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getReceivedBytes:member(1)", "docComment": "/**\n * Returns the received bytes of the download item.\n *\n * @returns The number of received bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getReceivedBytes(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getReceivedBytes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getSaveDialogOptions:member(1)", "docComment": "/**\n * Returns the object previously set by `setSaveDialogOptions`.\n *\n * @returns The save dialog options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSaveDialogOptions(): " }, { "kind": "Reference", "text": "ElectronSaveDialogOptions", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSaveDialogOptions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getSavePath:member(1)", "docComment": "/**\n * Returns the save path of the download item.\n *\n * @returns The save path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSavePath(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSavePath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getStartTime:member(1)", "docComment": "/**\n * Returns the number of seconds since the UNIX epoch when the download was started.\n *\n * @returns The start time in seconds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getStartTime(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getStartTime" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getState:member(1)", "docComment": "/**\n * Returns the current state of the download.\n *\n * @returns The current state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getState(): " }, { "kind": "Content", "text": "'cancelled' | 'completed' | 'interrupted' | 'progressing'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getTotalBytes:member(1)", "docComment": "/**\n * Returns the total size in bytes of the download item. Returns 0 if the size is unknown.\n *\n * @returns The total number of bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTotalBytes(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTotalBytes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getURL:member(1)", "docComment": "/**\n * Returns the origin URL where the item is downloaded from.\n *\n * @returns The origin URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getURL(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#getURLChain:member(1)", "docComment": "/**\n * Returns the complete URL chain of the item including any redirects.\n *\n * @returns The URL chain.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getURLChain(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getURLChain" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#hasUserGesture:member(1)", "docComment": "/**\n * Returns whether the download has a user gesture.\n *\n * @returns Whether the download has a user gesture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasUserGesture(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hasUserGesture" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#isPaused:member(1)", "docComment": "/**\n * Returns whether the download is paused.\n *\n * @returns Whether the download is paused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPaused(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isPaused" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#on:member(1)", "docComment": "/**\n * Registers a listener for the `done` event, emitted when the download reaches a terminal state.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the terminal state of the download.\n *\n * @returns This download item instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'done'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", state: 'cancelled' | 'completed' | 'interrupted') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#on:member(2)", "docComment": "/**\n * Registers a listener for the `updated` event, emitted when the download has been updated and is not done.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the current state of the download.\n *\n * @returns This download item instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", state: 'interrupted' | 'progressing') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `done` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the terminal state of the download.\n *\n * @returns This download item instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'done'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", state: 'cancelled' | 'completed' | 'interrupted') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the current state of the download.\n *\n * @returns This download item instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", state: 'interrupted' | 'progressing') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#pause:member(1)", "docComment": "/**\n * Pauses the download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pause(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "pause" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#removeListener:member(1)", "docComment": "/**\n * Removes a previously registered `done` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This download item instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'done'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", state: 'cancelled' | 'completed' | 'interrupted') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#removeListener:member(2)", "docComment": "/**\n * Removes a previously registered `updated` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This download item instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", state: 'interrupted' | 'progressing') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#resume:member(1)", "docComment": "/**\n * Resumes the download that has been paused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resume(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "resume" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#savePath:member", "docComment": "/**\n * The save file path of the download item. Only settable in the session's `will-download` callback.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "savePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "savePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#setSaveDialogOptions:member(1)", "docComment": "/**\n * Sets custom options for the save dialog. Only available in the session's `will-download` callback.\n *\n * @param options - The save dialog options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSaveDialogOptions(options: " }, { "kind": "Reference", "text": "ElectronSaveDialogOptions", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSaveDialogOptions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronDownloadItem#setSavePath:member(1)", "docComment": "/**\n * Sets the save path of the download item. Only available in the session's `will-download` callback.\n *\n * @param path - The save path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSavePath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSavePath" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronEditFlags:interface", "docComment": "/**\n * Flags indicating which editing actions the renderer believes it can perform.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronEditFlags " } ], "fileUrlPath": "src/electron/internals/ElectronEditFlags.d.ts", "releaseTag": "Public", "name": "ElectronEditFlags", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEditFlags#canCopy:member", "docComment": "/**\n * Whether the renderer believes it can copy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canCopy: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canCopy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEditFlags#canCut:member", "docComment": "/**\n * Whether the renderer believes it can cut.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canCut: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canCut", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEditFlags#canDelete:member", "docComment": "/**\n * Whether the renderer believes it can delete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canDelete: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canDelete", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEditFlags#canEditRichly:member", "docComment": "/**\n * Whether the renderer believes it can edit text richly.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canEditRichly: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canEditRichly", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEditFlags#canPaste:member", "docComment": "/**\n * Whether the renderer believes it can paste.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canPaste: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canPaste", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEditFlags#canRedo:member", "docComment": "/**\n * Whether the renderer believes it can redo.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canRedo: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canRedo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEditFlags#canSelectAll:member", "docComment": "/**\n * Whether the renderer believes it can select all.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canSelectAll: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canSelectAll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEditFlags#canUndo:member", "docComment": "/**\n * Whether the renderer believes it can undo.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canUndo: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canUndo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronEnableNetworkEmulationOptions:interface", "docComment": "/**\n * Options for emulating network conditions for a session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronEnableNetworkEmulationOptions " } ], "fileUrlPath": "src/electron/internals/ElectronEnableNetworkEmulationOptions.d.ts", "releaseTag": "Public", "name": "ElectronEnableNetworkEmulationOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEnableNetworkEmulationOptions#downloadThroughput:member", "docComment": "/**\n * Download rate in Bps. `0` disables download throttling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadThroughput?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "downloadThroughput", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEnableNetworkEmulationOptions#latency:member", "docComment": "/**\n * RTT in ms. `0` disables latency throttling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "latency?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "latency", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEnableNetworkEmulationOptions#offline:member", "docComment": "/**\n * Whether to emulate network outage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offline?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "offline", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronEnableNetworkEmulationOptions#uploadThroughput:member", "docComment": "/**\n * Upload rate in Bps. `0` disables upload throttling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uploadThroughput?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "uploadThroughput", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronEvent:interface", "docComment": "/**\n * Electron event object passed to event listeners, extending the DOM `Event`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronEvent extends " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronEvent.d.ts", "releaseTag": "Public", "name": "ElectronEvent", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronEvent#preventDefault:member(1)", "docComment": "/**\n * Prevents the default action associated with the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preventDefault(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "preventDefault" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronExtension:interface", "docComment": "/**\n * A loaded Chrome extension.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronExtension " } ], "fileUrlPath": "src/electron/internals/ElectronExtension.d.ts", "releaseTag": "Public", "name": "ElectronExtension", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronExtension#id:member", "docComment": "/**\n * The extension id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronExtension#manifest:member", "docComment": "/**\n * Copy of the extension's manifest data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "manifest: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "manifest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronExtension#name:member", "docComment": "/**\n * The extension name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronExtension#path:member", "docComment": "/**\n * The extension's file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronExtension#url:member", "docComment": "/**\n * The extension's `chrome-extension://` URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronExtension#version:member", "docComment": "/**\n * The extension version.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronFeedURLOptions:interface", "docComment": "/**\n * Options for configuring the auto updater feed URL.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronFeedURLOptions " } ], "fileUrlPath": "src/electron/internals/ElectronFeedURLOptions.d.ts", "releaseTag": "Public", "name": "ElectronFeedURLOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFeedURLOptions#headers:member", "docComment": "/**\n * HTTP request headers (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headers?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFeedURLOptions#serverType:member", "docComment": "/**\n * Can be `json` or `default`, see the Squirrel.Mac README for more information (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serverType?: " }, { "kind": "Content", "text": "'default' | 'json'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "serverType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFeedURLOptions#url:member", "docComment": "/**\n * The feed URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronFileFilter:interface", "docComment": "/**\n * File filter for Electron dialog file type selection.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronFileFilter " } ], "fileUrlPath": "src/electron/internals/ElectronFileFilter.d.ts", "releaseTag": "Public", "name": "ElectronFileFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFileFilter#extensions:member", "docComment": "/**\n * The file extensions to filter (without dots).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extensions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "extensions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFileFilter#name:member", "docComment": "/**\n * The display name of the filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronFileIconOptions:interface", "docComment": "/**\n * Options for fetching a file's associated icon.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronFileIconOptions " } ], "fileUrlPath": "src/electron/internals/ElectronFileIconOptions.d.ts", "releaseTag": "Public", "name": "ElectronFileIconOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFileIconOptions#size:member", "docComment": "/**\n * The size of the icon to fetch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size: " }, { "kind": "Content", "text": "'large' | 'normal' | 'small'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "size", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronFindInPageOptions:interface", "docComment": "/**\n * Options for a find-in-page request.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronFindInPageOptions " } ], "fileUrlPath": "src/electron/internals/ElectronFindInPageOptions.d.ts", "releaseTag": "Public", "name": "ElectronFindInPageOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFindInPageOptions#findNext:member", "docComment": "/**\n * Whether to begin a new text finding session with this request. Should be `true` for initial requests, and `false` for follow-up requests.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findNext?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "findNext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFindInPageOptions#forward:member", "docComment": "/**\n * Whether to search forward or backward.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forward?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "forward", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFindInPageOptions#matchCase:member", "docComment": "/**\n * Whether the search should be case-sensitive.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "matchCase?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "matchCase", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronFocusOptions:interface", "docComment": "/**\n * Options for focusing the application.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronFocusOptions " } ], "fileUrlPath": "src/electron/internals/ElectronFocusOptions.d.ts", "releaseTag": "Public", "name": "ElectronFocusOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFocusOptions#steal:member", "docComment": "/**\n * Make the receiver the active app even if another app is currently active. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "steal: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "steal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronFrameCreatedDetails:interface", "docComment": "/**\n * Details about a newly created frame.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronFrameCreatedDetails " } ], "fileUrlPath": "src/electron/internals/ElectronFrameCreatedDetails.d.ts", "releaseTag": "Public", "name": "ElectronFrameCreatedDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFrameCreatedDetails#frame:member", "docComment": "/**\n * The frame that was created.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronFromPartitionOptions:interface", "docComment": "/**\n * Options used when creating a session from a partition.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronFromPartitionOptions " } ], "fileUrlPath": "src/electron/internals/ElectronFromPartitionOptions.d.ts", "releaseTag": "Public", "name": "ElectronFromPartitionOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronFromPartitionOptions#cache:member", "docComment": "/**\n * Whether to enable cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cache: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cache", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronGlobalShortcut:interface", "docComment": "/**\n * Detects keyboard events when the application does not have keyboard focus.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronGlobalShortcut " } ], "fileUrlPath": "src/electron/internals/ElectronGlobalShortcut.d.ts", "releaseTag": "Public", "name": "ElectronGlobalShortcut", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronGlobalShortcut#isRegistered:member(1)", "docComment": "/**\n * Returns whether this application has registered `accelerator`.\n *\n * When the accelerator is already taken by other applications, this call will still return `false`. This behavior is intended by operating systems, since they don't want applications to fight for global shortcuts.\n *\n * @param accelerator - The accelerator to check.\n *\n * @returns Whether this application has registered `accelerator`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isRegistered(accelerator: " }, { "kind": "Reference", "text": "ElectronAccelerator", "canonicalReference": "obsidian-typings!ElectronAccelerator:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "accelerator", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isRegistered" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronGlobalShortcut#register:member(1)", "docComment": "/**\n * Registers a global shortcut of `accelerator`. The `callback` is called when the registered shortcut is pressed by the user.\n *\n * When the accelerator is already taken by other applications, this call will silently fail.\n *\n * @param accelerator - The accelerator to register.\n *\n * @param callback - Called when the registered shortcut is pressed.\n *\n * @returns Whether or not the shortcut was registered successfully.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "register(accelerator: " }, { "kind": "Reference", "text": "ElectronAccelerator", "canonicalReference": "obsidian-typings!ElectronAccelerator:type" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "accelerator", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "register" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronGlobalShortcut#registerAll:member(1)", "docComment": "/**\n * Registers a global shortcut of all `accelerator` items in `accelerators`. The `callback` is called when any of the registered shortcuts are pressed by the user.\n *\n * When a given accelerator is already taken by other applications, this call will silently fail.\n *\n * @param accelerators - The accelerators to register.\n *\n * @param callback - Called when any of the registered shortcuts is pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerAll(accelerators: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "accelerators", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "registerAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronGlobalShortcut#unregister:member(1)", "docComment": "/**\n * Unregisters the global shortcut of `accelerator`.\n *\n * @param accelerator - The accelerator to unregister.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unregister(accelerator: " }, { "kind": "Reference", "text": "ElectronAccelerator", "canonicalReference": "obsidian-typings!ElectronAccelerator:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "accelerator", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unregister" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronGlobalShortcut#unregisterAll:member(1)", "docComment": "/**\n * Unregisters all of the global shortcuts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unregisterAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "unregisterAll" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus:interface", "docComment": "/**\n * The Graphics Feature Status from `chrome://gpu/`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronGPUFeatureStatus " } ], "fileUrlPath": "src/electron/internals/ElectronGPUFeatureStatus.d.ts", "releaseTag": "Public", "name": "ElectronGPUFeatureStatus", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#\"2d_canvas\":member", "docComment": "/**\n * Canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'2d_canvas': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\"2d_canvas\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#flash_3d:member", "docComment": "/**\n * Flash.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'flash_3d': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "flash_3d", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#flash_stage3d_baseline:member", "docComment": "/**\n * Flash Stage3D Baseline profile.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'flash_stage3d_baseline': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "flash_stage3d_baseline", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#flash_stage3d:member", "docComment": "/**\n * Flash Stage3D.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'flash_stage3d': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "flash_stage3d", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#gpu_compositing:member", "docComment": "/**\n * Compositing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'gpu_compositing': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "gpu_compositing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#multiple_raster_threads:member", "docComment": "/**\n * Multiple Raster Threads.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'multiple_raster_threads': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "multiple_raster_threads", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#native_gpu_memory_buffers:member", "docComment": "/**\n * Native GpuMemoryBuffers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'native_gpu_memory_buffers': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "native_gpu_memory_buffers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#rasterization:member", "docComment": "/**\n * Rasterization.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'rasterization': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rasterization", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#video_decode:member", "docComment": "/**\n * Video Decode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'video_decode': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "video_decode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#video_encode:member", "docComment": "/**\n * Video Encode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'video_encode': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "video_encode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#vpx_decode:member", "docComment": "/**\n * VPx Video Decode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'vpx_decode': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vpx_decode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#webgl:member", "docComment": "/**\n * WebGL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'webgl': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webgl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronGPUFeatureStatus#webgl2:member", "docComment": "/**\n * WebGL2.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'webgl2': " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webgl2", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronHandlerDetails:interface", "docComment": "/**\n * Details about a window open request handled by a window open handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronHandlerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronHandlerDetails.d.ts", "releaseTag": "Public", "name": "ElectronHandlerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHandlerDetails#disposition:member", "docComment": "/**\n * The disposition requested for the new window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disposition: " }, { "kind": "Content", "text": "'background-tab' | 'default' | 'foreground-tab' | 'new-window' | 'other' | 'save-to-disk'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disposition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHandlerDetails#features:member", "docComment": "/**\n * Comma-separated list of window features provided to `window.open()`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "features: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "features", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHandlerDetails#frameName:member", "docComment": "/**\n * Name of the window provided in `window.open()`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frameName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frameName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHandlerDetails#postBody:member", "docComment": "/**\n * The post data that will be sent to the new window, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postBody?: " }, { "kind": "Reference", "text": "ElectronPostBody", "canonicalReference": "obsidian-typings!ElectronPostBody:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "postBody", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHandlerDetails#referrer:member", "docComment": "/**\n * The referrer that will be passed to the new window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Reference", "text": "ElectronReferrer", "canonicalReference": "obsidian-typings!ElectronReferrer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHandlerDetails#url:member", "docComment": "/**\n * The resolved version of the URL passed to `window.open()`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronHeadersReceivedResponse:interface", "docComment": "/**\n * Response object returned by an `onHeadersReceived` web-request listener callback.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronHeadersReceivedResponse " } ], "fileUrlPath": "src/electron/internals/ElectronHeadersReceivedResponse.d.ts", "releaseTag": "Public", "name": "ElectronHeadersReceivedResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHeadersReceivedResponse#cancel:member", "docComment": "/**\n * Whether to cancel the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cancel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHeadersReceivedResponse#responseHeaders:member", "docComment": "/**\n * When provided, the server is assumed to have responded with these headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "responseHeaders?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string | string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHeadersReceivedResponse#statusLine:member", "docComment": "/**\n * Should be provided when overriding `responseHeaders` to change header status otherwise original response header's status will be used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusLine?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "statusLine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronHIDDevice:interface", "docComment": "/**\n * A HID device available for selection via the Web HID API.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronHIDDevice " } ], "fileUrlPath": "src/electron/internals/ElectronHIDDevice.d.ts", "releaseTag": "Public", "name": "ElectronHIDDevice", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHIDDevice#deviceId:member", "docComment": "/**\n * Unique identifier for the device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deviceId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHIDDevice#guid:member", "docComment": "/**\n * Unique identifier for the HID interface. A device may have multiple HID interfaces.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "guid?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "guid", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHIDDevice#name:member", "docComment": "/**\n * Name of the device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHIDDevice#productId:member", "docComment": "/**\n * The USB product ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "productId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "productId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHIDDevice#serialNumber:member", "docComment": "/**\n * The USB device serial number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialNumber?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "serialNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHIDDevice#vendorId:member", "docComment": "/**\n * The USB vendor ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vendorId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vendorId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronHidDeviceAddedDetails:interface", "docComment": "/**\n * Details passed to the `hid-device-added` session event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronHidDeviceAddedDetails " } ], "fileUrlPath": "src/electron/internals/ElectronHidDeviceAddedDetails.d.ts", "releaseTag": "Public", "name": "ElectronHidDeviceAddedDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHidDeviceAddedDetails#device:member", "docComment": "/**\n * The HID devices that became available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "device: " }, { "kind": "Reference", "text": "ElectronHIDDevice", "canonicalReference": "obsidian-typings!ElectronHIDDevice:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "device", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHidDeviceAddedDetails#frame:member", "docComment": "/**\n * The frame that requested the device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronHidDeviceRemovedDetails:interface", "docComment": "/**\n * Details passed to the `hid-device-removed` session event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronHidDeviceRemovedDetails " } ], "fileUrlPath": "src/electron/internals/ElectronHidDeviceRemovedDetails.d.ts", "releaseTag": "Public", "name": "ElectronHidDeviceRemovedDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHidDeviceRemovedDetails#device:member", "docComment": "/**\n * The HID devices that were removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "device: " }, { "kind": "Reference", "text": "ElectronHIDDevice", "canonicalReference": "obsidian-typings!ElectronHIDDevice:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "device", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronHidDeviceRemovedDetails#frame:member", "docComment": "/**\n * The frame associated with the removed device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronIgnoreMouseEventsOptions:interface", "docComment": "/**\n * Options for {@link ElectronBrowserWindow.setIgnoreMouseEvents}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronIgnoreMouseEventsOptions " } ], "fileUrlPath": "src/electron/internals/ElectronIgnoreMouseEventsOptions.d.ts", "releaseTag": "Public", "name": "ElectronIgnoreMouseEventsOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIgnoreMouseEventsOptions#forward:member", "docComment": "/**\n * If `true`, forwards mouse move messages to Chromium, enabling mouse related events such as `mouseleave`. Only used when `ignore` is `true`. If `ignore` is `false`, forwarding is always disabled regardless of this value.\n *\n * Available on macOS and Windows.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forward?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "forward", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronImportCertificateOptions:interface", "docComment": "/**\n * Options for importing a certificate into the platform certificate store.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronImportCertificateOptions " } ], "fileUrlPath": "src/electron/internals/ElectronImportCertificateOptions.d.ts", "releaseTag": "Public", "name": "ElectronImportCertificateOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronImportCertificateOptions#certificate:member", "docComment": "/**\n * Path for the pkcs12 file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "certificate: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "certificate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronImportCertificateOptions#password:member", "docComment": "/**\n * Passphrase for the certificate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "password: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "password", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronInAppPurchase:interface", "docComment": "/**\n * In-app purchases on the Mac App Store.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronInAppPurchase " } ], "fileUrlPath": "src/electron/internals/ElectronInAppPurchase.d.ts", "releaseTag": "Public", "name": "ElectronInAppPurchase", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#addListener:member(1)", "docComment": "/**\n * Adds a listener for the `transactions-updated` event.\n *\n * Emitted when one or more transactions have been updated.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronInAppPurchase` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'transactions-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", transactions: " }, { "kind": "Reference", "text": "ElectronTransaction", "canonicalReference": "obsidian-typings!ElectronTransaction:interface" }, { "kind": "Content", "text": "[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#canMakePayments:member(1)", "docComment": "/**\n * Returns whether a user can make a payment.\n *\n * @returns Whether a user can make a payment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canMakePayments(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canMakePayments" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#finishAllTransactions:member(1)", "docComment": "/**\n * Completes all pending transactions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "finishAllTransactions(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "finishAllTransactions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#finishTransactionByDate:member(1)", "docComment": "/**\n * Completes the pending transactions corresponding to the date.\n *\n * @param date - The date of the transactions to finish.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "finishTransactionByDate(date: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "date", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "finishTransactionByDate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#getProducts:member(1)", "docComment": "/**\n * Retrieves the product descriptions.\n *\n * @param productIDs - The identifiers of the products to retrieve.\n *\n * @returns A promise that resolves with an array of `ElectronProduct` objects.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getProducts(productIDs: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronProduct", "canonicalReference": "obsidian-typings!ElectronProduct:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "productIDs", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getProducts" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#getReceiptURL:member(1)", "docComment": "/**\n * Returns the path to the receipt.\n *\n * @returns The path to the receipt.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getReceiptURL(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getReceiptURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#on:member(1)", "docComment": "/**\n * Registers a listener for the `transactions-updated` event.\n *\n * Emitted when one or more transactions have been updated.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronInAppPurchase` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'transactions-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", transactions: " }, { "kind": "Reference", "text": "ElectronTransaction", "canonicalReference": "obsidian-typings!ElectronTransaction:interface" }, { "kind": "Content", "text": "[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `transactions-updated` event.\n *\n * Emitted when one or more transactions have been updated.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronInAppPurchase` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'transactions-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", transactions: " }, { "kind": "Reference", "text": "ElectronTransaction", "canonicalReference": "obsidian-typings!ElectronTransaction:interface" }, { "kind": "Content", "text": "[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#purchaseProduct:member(1)", "docComment": "/**\n * Adds the specified product to the payment queue. You should listen for the `transactions-updated` event as soon as possible and certainly before you call `purchaseProduct`.\n *\n * @param productID - The identifier of the product to purchase.\n *\n * @param quantity - The number of items the user wants to purchase.\n *\n * @returns A promise that resolves with `true` if the product is valid and added to the payment queue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "purchaseProduct(productID: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", quantity?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<boolean>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "productID", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "quantity", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "purchaseProduct" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#removeListener:member(1)", "docComment": "/**\n * Removes a previously added listener for the `transactions-updated` event.\n *\n * Emitted when one or more transactions have been updated.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronInAppPurchase` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'transactions-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", transactions: " }, { "kind": "Reference", "text": "ElectronTransaction", "canonicalReference": "obsidian-typings!ElectronTransaction:interface" }, { "kind": "Content", "text": "[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronInAppPurchase#restoreCompletedTransactions:member(1)", "docComment": "/**\n * Restores finished transactions. This method can be called either to install purchases on additional devices, or to restore purchases for an application that the user deleted and reinstalled.\n *\n * The payment queue delivers a new transaction for each previously completed transaction that can be restored. Each transaction includes a copy of the original transaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "restoreCompletedTransactions(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "restoreCompletedTransactions" } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronIncomingMessage:class", "docComment": "/**\n * An HTTP response message returned by a `ClientRequest`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronIncomingMessage " } ], "fileUrlPath": "src/electron/internals/ElectronIncomingMessage.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronIncomingMessage", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#addListener:member(1)", "docComment": "/**\n * Registers a listener for the given response event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `IncomingMessage` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'aborted'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#addListener:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'data'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(chunk: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#addListener:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#addListener:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#headers:member", "docComment": "/**\n * A `Record<string, string | string[]>` representing the HTTP response headers. The `headers` object is formatted as follows:\n *\n * - All header names are lowercased. - Duplicates of `age`, `authorization`, `content-length`, `content-type`, `etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`, `last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`, `retry-after`, `server`, or `user-agent` are discarded. - `set-cookie` is always an array. Duplicates are added to the array. - For duplicate `cookie` headers, the values are joined together with `'; '`. - For all other headers, the values are joined together with `', '`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headers: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string | string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#httpVersion:member", "docComment": "/**\n * A `string` indicating the HTTP protocol version number. Typical values are `'1.0'` or `'1.1'`. Additionally `httpVersionMajor` and `httpVersionMinor` are two Integer-valued readable properties that return respectively the HTTP major and minor version numbers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "httpVersion: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "httpVersion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#httpVersionMajor:member", "docComment": "/**\n * An `Integer` indicating the HTTP protocol major version number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "httpVersionMajor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "httpVersionMajor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#httpVersionMinor:member", "docComment": "/**\n * An `Integer` indicating the HTTP protocol minor version number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "httpVersionMinor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "httpVersionMinor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#on:member(1)", "docComment": "/**\n * Registers a listener for the given response event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `IncomingMessage` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'aborted'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#on:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'data'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(chunk: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#on:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#on:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the given response event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `IncomingMessage` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'aborted'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#once:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'data'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(chunk: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#once:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#once:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#rawHeaders:member", "docComment": "/**\n * A `string[]` containing the raw HTTP response headers exactly as they were received. The keys and values are in the same list. It is not a list of tuples. So, the even-numbered offsets are key values, and the odd-numbered offsets are the associated values. Header names are not lowercased, and duplicates are not merged.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rawHeaders: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rawHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#removeListener:member(1)", "docComment": "/**\n * Removes the given listener for the given response event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `IncomingMessage` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'aborted'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#removeListener:member(2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'data'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(chunk: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#removeListener:member(3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#removeListener:member(4)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#statusCode:member", "docComment": "/**\n * An `Integer` indicating the HTTP response status code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronIncomingMessage#statusMessage:member", "docComment": "/**\n * A `string` representing the HTTP status message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusMessage: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusMessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronInfo:interface", "docComment": "/**\n * Security origin, content security policy and name of an isolated world.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronInfo " } ], "fileUrlPath": "src/electron/internals/ElectronInfo.d.ts", "releaseTag": "Public", "name": "ElectronInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInfo#csp:member", "docComment": "/**\n * Content Security Policy for the isolated world.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "csp?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "csp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInfo#name:member", "docComment": "/**\n * Name for isolated world. Useful in devtools.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInfo#securityOrigin:member", "docComment": "/**\n * Security origin for the isolated world.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "securityOrigin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "securityOrigin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronInput:interface", "docComment": "/**\n * Input properties describing a keyboard event dispatched to the page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronInput " } ], "fileUrlPath": "src/electron/internals/ElectronInput.d.ts", "releaseTag": "Public", "name": "ElectronInput", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#alt:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.altKey`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alt: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "alt", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#code:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.code`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "code: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "code", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#control:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.controlKey`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "control: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "control", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#isAutoRepeat:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.repeat`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAutoRepeat: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isAutoRepeat", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#isComposing:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.isComposing`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isComposing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isComposing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#key:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.key`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#location:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.location`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "location: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "location", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#meta:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.metaKey`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "meta: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "meta", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#modifiers:member", "docComment": "/**\n * The modifiers of the input event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modifiers: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modifiers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#shift:member", "docComment": "/**\n * Equivalent to `KeyboardEvent.shiftKey`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shift: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "shift", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInput#type:member", "docComment": "/**\n * Either `keyUp` or `keyDown`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronInputEvent:interface", "docComment": "/**\n * Base shape shared by every Electron input event passed to {@link ElectronWebContents.sendInputEvent}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronInputEvent " } ], "fileUrlPath": "src/electron/internals/ElectronInputEvent.d.ts", "releaseTag": "Public", "name": "ElectronInputEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInputEvent#modifiers:member", "docComment": "/**\n * The modifier keys held during the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modifiers?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<\n | 'alt'\n | 'capsLock'\n | 'cmd'\n | 'command'\n | 'control'\n | 'ctrl'\n | 'isAutoRepeat'\n | 'isKeypad'\n | 'left'\n | 'leftButtonDown'\n | 'meta'\n | 'middleButtonDown'\n | 'numLock'\n | 'right'\n | 'rightButtonDown'\n | 'shift'\n >" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "modifiers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronInsertCSSOptions:interface", "docComment": "/**\n * Options for inserting CSS into a web page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronInsertCSSOptions " } ], "fileUrlPath": "src/electron/internals/ElectronInsertCSSOptions.d.ts", "releaseTag": "Public", "name": "ElectronInsertCSSOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronInsertCSSOptions#cssOrigin:member", "docComment": "/**\n * Sets the cascade origin of the inserted stylesheet. Can be either `user` or `author`.\n *\n * @default\n *\n * `'author'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cssOrigin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cssOrigin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronIpcMain:interface", "docComment": "/**\n * Electron IPC main for communicating with renderer processes from the main process.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronIpcMain extends " }, { "kind": "Reference", "text": "NodeJS.EventEmitter", "canonicalReference": "!\"\\\"node:events\\\"\".__global.NodeJS.EventEmitter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronIpcMain.d.ts", "releaseTag": "Public", "name": "ElectronIpcMain", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcMain#handle:member(1)", "docComment": "/**\n * Adds a handler for an `invoke`able IPC. This handler is called whenever a renderer calls `ipcRenderer.invoke(channel, ...args)`.\n *\n * If `listener` returns a `Promise`, the eventual result of the promise is returned as a reply to the remote caller. Otherwise, the return value of the listener is used as the value of the reply.\n *\n * The `event` passed as the first argument to the handler is the same as that passed to a regular event listener. It includes information about which `WebContents` is the source of the invoke request.\n *\n * @param channel - The IPC channel name.\n *\n * @param listener - Callback invoked to handle the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handle(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronIpcMainInvokeEvent", "canonicalReference": "obsidian-typings!ElectronIpcMainInvokeEvent:interface" }, { "kind": "Content", "text": ", ...args: unknown[]) => unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "handle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcMain#handleOnce:member(1)", "docComment": "/**\n * Handles a single `invoke`able IPC message, then removes the listener. See `ipcMain.handle(channel, listener)`.\n *\n * @param channel - The IPC channel name.\n *\n * @param listener - Callback invoked to handle the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleOnce(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronIpcMainInvokeEvent", "canonicalReference": "obsidian-typings!ElectronIpcMainInvokeEvent:interface" }, { "kind": "Content", "text": ", ...args: unknown[]) => unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "handleOnce" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcMain#on:member(1)", "docComment": "/**\n * Listens to `channel`; when a new message arrives `listener` is called with `listener(event, args...)`.\n *\n * @param channel - The IPC channel name.\n *\n * @param listener - Callback invoked when a message is received.\n *\n * @returns This `IpcMain` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronIpcMainEvent", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent:interface" }, { "kind": "Content", "text": ", ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcMain#once:member(1)", "docComment": "/**\n * Adds a one-time `listener` function for the event, invoked only the next time a message is sent to `channel`, after which it is removed.\n *\n * @param channel - The IPC channel name.\n *\n * @param listener - Callback invoked when a message is received.\n *\n * @returns This `IpcMain` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronIpcMainEvent", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent:interface" }, { "kind": "Content", "text": ", ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcMain#removeAllListeners:member(1)", "docComment": "/**\n * Removes listeners of the specified `channel`.\n *\n * @param channel - The IPC channel name.\n *\n * @returns This `IpcMain` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeAllListeners(channel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "removeAllListeners" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcMain#removeHandler:member(1)", "docComment": "/**\n * Removes any handler for `channel`, if present.\n *\n * @param channel - The IPC channel name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeHandler(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcMain#removeListener:member(1)", "docComment": "/**\n * Removes the specified `listener` from the listener array for the specified `channel`.\n *\n * @param channel - The IPC channel name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `IpcMain` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent:interface", "docComment": "/**\n * Event passed as the first argument to `ipcMain` `on`/`once` listeners.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronIpcMainEvent " } ], "fileUrlPath": "src/electron/internals/ElectronIpcMainEvent.d.ts", "releaseTag": "Public", "name": "ElectronIpcMainEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent#frameId:member", "docComment": "/**\n * The ID of the renderer frame that sent this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frameId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frameId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent#ports:member", "docComment": "/**\n * A list of message ports that were transferred with this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ports: " }, { "kind": "Reference", "text": "ElectronMessagePortMain", "canonicalReference": "obsidian-typings!ElectronMessagePortMain:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ports", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent#processId:member", "docComment": "/**\n * The internal ID of the renderer process that sent this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "processId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "processId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent#reply:member(1)", "docComment": "/**\n * Sends an IPC message to the renderer frame that sent the original message that is currently being handled. Use this method to \"reply\" to the sent message in order to guarantee the reply goes to the correct process and frame.\n *\n * @param channel - The IPC channel name.\n *\n * @param args - Arguments to send back to the renderer frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reply(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "reply" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent#returnValue:member", "docComment": "/**\n * Set this to the value to be returned in a synchronous message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "returnValue: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "returnValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent#sender:member", "docComment": "/**\n * The `webContents` that sent the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sender: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainEvent#senderFrame:member", "docComment": "/**\n * The frame that sent this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly senderFrame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "senderFrame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronIpcMainInvokeEvent:interface", "docComment": "/**\n * Event passed as the first argument to `ipcMain` `handle`/`handleOnce` handlers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronIpcMainInvokeEvent extends " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronIpcMainInvokeEvent.d.ts", "releaseTag": "Public", "name": "ElectronIpcMainInvokeEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainInvokeEvent#frameId:member", "docComment": "/**\n * The ID of the renderer frame that sent this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frameId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frameId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainInvokeEvent#processId:member", "docComment": "/**\n * The internal ID of the renderer process that sent this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "processId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "processId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainInvokeEvent#sender:member", "docComment": "/**\n * The `webContents` that sent the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sender: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronIpcMainInvokeEvent#senderFrame:member", "docComment": "/**\n * The frame that sent this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly senderFrame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "senderFrame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronIpcRenderer:interface", "docComment": "/**\n * Electron IPC renderer for communicating with the main process.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronIpcRenderer extends " }, { "kind": "Reference", "text": "NodeJS.EventEmitter", "canonicalReference": "!\"\\\"node:events\\\"\".__global.NodeJS.EventEmitter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronIpcRenderer.d.ts", "releaseTag": "Public", "name": "ElectronIpcRenderer", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#invoke:member(1)", "docComment": "/**\n * Sends a message to the main process via `channel` and expects a result asynchronously.\n *\n * The main process should listen for `channel` with `ipcMain.handle()`. Arguments are serialized with the Structured Clone Algorithm, so prototype chains are not included and sending functions, promises, symbols, weak maps, or weak sets throws an exception.\n *\n * @param channel - The IPC channel name.\n *\n * @param args - Arguments to send.\n *\n * @returns A promise resolving with the response from the main process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "invoke(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "invoke" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#on:member(1)", "docComment": "/**\n * Listens to `channel`; when a new message arrives `listener` is called with `listener(event, args...)`.\n *\n * @param channel - The IPC channel name.\n *\n * @param listener - Callback invoked when a message is received.\n *\n * @returns This `IpcRenderer` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "IpcRendererEvent", "canonicalReference": "obsidian-typings!IpcRendererEvent:interface" }, { "kind": "Content", "text": ", ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#once:member(1)", "docComment": "/**\n * Adds a one-time `listener` function for the event, invoked only the next time a message is sent to `channel`, after which it is removed.\n *\n * @param channel - The IPC channel name.\n *\n * @param listener - Callback invoked when a message is received.\n *\n * @returns This `IpcRenderer` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "IpcRendererEvent", "canonicalReference": "obsidian-typings!IpcRendererEvent:interface" }, { "kind": "Content", "text": ", ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#postMessage:member(1)", "docComment": "/**\n * Sends a message to the main process, optionally transferring ownership of zero or more `MessagePort` objects. The transferred ports are available in the main process as `MessagePortMain` objects via the `ports` property of the emitted event.\n *\n * @param channel - The IPC channel name.\n *\n * @param message - The message to send.\n *\n * @param transfer - Optional transferable `MessagePort` objects.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postMessage(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", message: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", transfer?: " }, { "kind": "Reference", "text": "MessagePort", "canonicalReference": "!MessagePort:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "transfer", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": true } ], "name": "postMessage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#removeAllListeners:member(1)", "docComment": "/**\n * Removes all listeners of the specified `channel`.\n *\n * @param channel - The IPC channel name.\n *\n * @returns This `IpcRenderer` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeAllListeners(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeAllListeners" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#removeListener:member(1)", "docComment": "/**\n * Removes the specified `listener` from the listener array for the specified `channel`.\n *\n * @param channel - The IPC channel name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `IpcRenderer` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#send:member(1)", "docComment": "/**\n * Sends an asynchronous message to the main process via `channel`, along with arguments.\n *\n * The main process handles it by listening for `channel` with the `ipcMain` module. Arguments are serialized with the Structured Clone Algorithm, so prototype chains are not included and sending functions, promises, symbols, weak maps, or weak sets throws an exception.\n *\n * @param channel - The IPC channel name.\n *\n * @param args - Arguments to send.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "send(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "send" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#sendSync:member(1)", "docComment": "/**\n * Sends a message to the main process via `channel` and expects a result synchronously.\n *\n * The main process handles it by listening for `channel` with the `ipcMain` module and replies by setting `event.returnValue`. Sending a synchronous message blocks the whole renderer process until the reply is received, so use this only as a last resort.\n *\n * @param channel - The IPC channel name.\n *\n * @param args - Arguments to send.\n *\n * @returns The value sent back by the `ipcMain` handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendSync(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "sendSync" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#sendTo:member(1)", "docComment": "/**\n * Sends a message to a window with `webContentsId` via `channel`.\n *\n * @param webContentsId - The `webContents.id` of the target window.\n *\n * @param channel - The IPC channel name.\n *\n * @param args - Arguments to send.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendTo(webContentsId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "webContentsId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "sendTo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronIpcRenderer#sendToHost:member(1)", "docComment": "/**\n * Like `send`, but the event is sent to the `<webview>` element in the host page instead of the main process.\n *\n * @param channel - The IPC channel name.\n *\n * @param args - Arguments to send.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendToHost(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "sendToHost" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronItem:interface", "docComment": "/**\n * The item to drag during a drag-and-drop operation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronItem " } ], "fileUrlPath": "src/electron/internals/ElectronItem.d.ts", "releaseTag": "Public", "name": "ElectronItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronItem#file:member", "docComment": "/**\n * The path to the file being dragged.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronItem#files:member", "docComment": "/**\n * The paths to the files being dragged. Overrides the `file` field.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "files?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "files", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronItem#icon:member", "docComment": "/**\n * The image shown under the cursor while dragging. Must be non-empty on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronJumpListCategory:interface", "docComment": "/**\n * A category in a Windows Jump List.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronJumpListCategory " } ], "fileUrlPath": "src/electron/internals/ElectronJumpListCategory.d.ts", "releaseTag": "Public", "name": "ElectronJumpListCategory", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListCategory#items:member", "docComment": "/**\n * Array of `ElectronJumpListItem` objects if `type` is `tasks` or `custom`, otherwise omitted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items?: " }, { "kind": "Reference", "text": "ElectronJumpListItem", "canonicalReference": "obsidian-typings!ElectronJumpListItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListCategory#name:member", "docComment": "/**\n * Must be set if `type` is `custom`, otherwise omitted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListCategory#type:member", "docComment": "/**\n * The type of the category.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Content", "text": "'custom' | 'frequent' | 'recent' | 'tasks'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronJumpListItem:interface", "docComment": "/**\n * A single item in a Windows Jump List.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronJumpListItem " } ], "fileUrlPath": "src/electron/internals/ElectronJumpListItem.d.ts", "releaseTag": "Public", "name": "ElectronJumpListItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#args:member", "docComment": "/**\n * The command line arguments when `program` is executed. Should only be set if `type` is `task`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#description:member", "docComment": "/**\n * Description of the task (displayed in a tooltip). Should only be set if `type` is `task`. Maximum length 260 characters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#iconIndex:member", "docComment": "/**\n * The zero-based index of the icon in the resource file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "iconIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#iconPath:member", "docComment": "/**\n * The absolute path to an icon to be displayed in a Jump List.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "iconPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#path:member", "docComment": "/**\n * Path of the file to open. Should only be set if `type` is `file`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#program:member", "docComment": "/**\n * Path of the program to execute. Should only be set if `type` is `task`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "program?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "program", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#title:member", "docComment": "/**\n * The text to be displayed for the item in the Jump List. Should only be set if `type` is `task`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#type:member", "docComment": "/**\n * The type of the Jump List item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Content", "text": "'file' | 'separator' | 'task'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListItem#workingDirectory:member", "docComment": "/**\n * The working directory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workingDirectory?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "workingDirectory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronJumpListSettings:interface", "docComment": "/**\n * Current settings of the Windows Jump List.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronJumpListSettings " } ], "fileUrlPath": "src/electron/internals/ElectronJumpListSettings.d.ts", "releaseTag": "Public", "name": "ElectronJumpListSettings", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListSettings#minItems:member", "docComment": "/**\n * The minimum number of items that will be shown in the Jump List.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minItems: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronJumpListSettings#removedItems:member", "docComment": "/**\n * Array of `ElectronJumpListItem` objects the user has explicitly removed from custom categories in the Jump List.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removedItems: " }, { "kind": "Reference", "text": "ElectronJumpListItem", "canonicalReference": "obsidian-typings!ElectronJumpListItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "removedItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface", "docComment": "/**\n * Modifier-key state describing how an accelerator-triggered event was activated.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronKeyboardEvent " } ], "fileUrlPath": "src/electron/internals/ElectronKeyboardEvent.d.ts", "releaseTag": "Public", "name": "ElectronKeyboardEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent#altKey:member", "docComment": "/**\n * Whether an Alt key was used in an accelerator to trigger the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "altKey?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "altKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent#ctrlKey:member", "docComment": "/**\n * Whether the Control key was used in an accelerator to trigger the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ctrlKey?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ctrlKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent#metaKey:member", "docComment": "/**\n * Whether a meta key was used in an accelerator to trigger the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "metaKey?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "metaKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent#shiftKey:member", "docComment": "/**\n * Whether a Shift key was used in an accelerator to trigger the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shiftKey?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "shiftKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent#triggeredByAccelerator:member", "docComment": "/**\n * Whether an accelerator was used to trigger the event as opposed to another user gesture like a mouse click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "triggeredByAccelerator?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "triggeredByAccelerator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronKeyboardInputEvent:interface", "docComment": "/**\n * Keyboard input event passed to {@link ElectronWebContents.sendInputEvent} to inject a trusted key press.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronKeyboardInputEvent extends " }, { "kind": "Reference", "text": "ElectronInputEvent", "canonicalReference": "obsidian-typings!ElectronInputEvent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronKeyboardInputEvent.d.ts", "releaseTag": "Public", "name": "ElectronKeyboardInputEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronKeyboardInputEvent#keyCode:member", "docComment": "/**\n * The character sent as the keyboard event; use a valid Electron Accelerator key code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyCode: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronKeyboardInputEvent#type:member", "docComment": "/**\n * The type of the keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'char' | 'keyDown' | 'keyUp'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronLaunchItems:interface", "docComment": "/**\n * A registry-backed login launch item on Windows.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronLaunchItems " } ], "fileUrlPath": "src/electron/internals/ElectronLaunchItems.d.ts", "releaseTag": "Public", "name": "ElectronLaunchItems", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLaunchItems#args:member", "docComment": "/**\n * The command-line arguments to pass to the executable. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLaunchItems#enabled:member", "docComment": "/**\n * `true` if the app registry key is startup approved and therefore shows as enabled in Task Manager and Windows settings. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLaunchItems#name:member", "docComment": "/**\n * Name value of a registry entry. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLaunchItems#path:member", "docComment": "/**\n * The executable to an app that corresponds to a registry entry. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLaunchItems#scope:member", "docComment": "/**\n * One of `user` or `machine`. Indicates whether the registry entry is under `HKEY_CURRENT_USER` or `HKEY_LOCAL_MACHINE`. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scope: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronLoadExtensionOptions:interface", "docComment": "/**\n * Options controlling how an extension is loaded.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronLoadExtensionOptions " } ], "fileUrlPath": "src/electron/internals/ElectronLoadExtensionOptions.d.ts", "releaseTag": "Public", "name": "ElectronLoadExtensionOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoadExtensionOptions#allowFileAccess:member", "docComment": "/**\n * Whether to allow the extension to read local files over the `file://` protocol and inject content scripts into `file://` pages.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowFileAccess: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "allowFileAccess", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings:interface", "docComment": "/**\n * The app's login item settings.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronLoginItemSettings " } ], "fileUrlPath": "src/electron/internals/ElectronLoginItemSettings.d.ts", "releaseTag": "Public", "name": "ElectronLoginItemSettings", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings#executableWillLaunchAtLogin:member", "docComment": "/**\n * `true` if app is set to open at login and its run key is not deactivated. Differs from `openAtLogin` as it ignores the `args` option. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executableWillLaunchAtLogin: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "executableWillLaunchAtLogin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings#launchItems:member", "docComment": "/**\n * The list of registry-backed launch items. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "launchItems: " }, { "kind": "Reference", "text": "ElectronLaunchItems", "canonicalReference": "obsidian-typings!ElectronLaunchItems:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "launchItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings#openAsHidden:member", "docComment": "/**\n * `true` if the app is set to open as hidden at login. Not available on MAS builds. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openAsHidden: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "openAsHidden", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings#openAtLogin:member", "docComment": "/**\n * `true` if the app is set to open at login.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openAtLogin: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "openAtLogin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings#restoreState:member", "docComment": "/**\n * `true` if the app was opened as a login item that should restore the state from the previous session. Not available on MAS builds. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "restoreState: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "restoreState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings#wasOpenedAsHidden:member", "docComment": "/**\n * `true` if the app was opened as a hidden login item. Not available on MAS builds. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wasOpenedAsHidden: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wasOpenedAsHidden", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettings#wasOpenedAtLogin:member", "docComment": "/**\n * `true` if the app was opened at login automatically. Not available on MAS builds. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wasOpenedAtLogin: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wasOpenedAtLogin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronLoginItemSettingsOptions:interface", "docComment": "/**\n * Options for querying the app's login item settings.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronLoginItemSettingsOptions " } ], "fileUrlPath": "src/electron/internals/ElectronLoginItemSettingsOptions.d.ts", "releaseTag": "Public", "name": "ElectronLoginItemSettingsOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettingsOptions#args:member", "docComment": "/**\n * The command-line arguments to compare against. Windows only.\n *\n * @default\n *\n * `[]`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronLoginItemSettingsOptions#path:member", "docComment": "/**\n * The executable path to compare against. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMargins:interface", "docComment": "/**\n * The margins of a printed web page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMargins " } ], "fileUrlPath": "src/electron/internals/ElectronMargins.d.ts", "releaseTag": "Public", "name": "ElectronMargins", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMargins#bottom:member", "docComment": "/**\n * The bottom margin of the printed web page, in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMargins#left:member", "docComment": "/**\n * The left margin of the printed web page, in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMargins#marginType:member", "docComment": "/**\n * The margin type. If `custom` is chosen, `top`, `bottom`, `left`, and `right` must also be specified.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "marginType?: " }, { "kind": "Content", "text": "'custom' | 'default' | 'none' | 'printableArea'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "marginType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMargins#right:member", "docComment": "/**\n * The right margin of the printed web page, in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "right?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMargins#top:member", "docComment": "/**\n * The top margin of the printed web page, in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMediaFlags:interface", "docComment": "/**\n * Flags describing the state of a media element under the context menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMediaFlags " } ], "fileUrlPath": "src/electron/internals/ElectronMediaFlags.d.ts", "releaseTag": "Public", "name": "ElectronMediaFlags", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#canLoop:member", "docComment": "/**\n * Whether the media element can be looped.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canLoop: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canLoop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#canPrint:member", "docComment": "/**\n * Whether the media element can be printed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canPrint: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canPrint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#canRotate:member", "docComment": "/**\n * Whether the media element can be rotated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canRotate: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canRotate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#canSave:member", "docComment": "/**\n * Whether the media element can be downloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canSave: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canSave", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#canShowPictureInPicture:member", "docComment": "/**\n * Whether the media element can show picture-in-picture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canShowPictureInPicture: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canShowPictureInPicture", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#canToggleControls:member", "docComment": "/**\n * Whether the media element's controls are toggleable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canToggleControls: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canToggleControls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#hasAudio:member", "docComment": "/**\n * Whether the media element has audio.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasAudio: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hasAudio", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#inError:member", "docComment": "/**\n * Whether the media element has crashed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inError: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inError", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#isControlsVisible:member", "docComment": "/**\n * Whether the media element's controls are visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isControlsVisible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isControlsVisible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#isLooping:member", "docComment": "/**\n * Whether the media element is looping.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isLooping: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isLooping", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#isMuted:member", "docComment": "/**\n * Whether the media element is muted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMuted: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMuted", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#isPaused:member", "docComment": "/**\n * Whether the media element is paused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPaused: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isPaused", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMediaFlags#isShowingPictureInPicture:member", "docComment": "/**\n * Whether the media element is currently showing picture-in-picture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isShowingPictureInPicture: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isShowingPictureInPicture", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMemoryInfo:interface", "docComment": "/**\n * Memory usage statistics for a process.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMemoryInfo " } ], "fileUrlPath": "src/electron/internals/ElectronMemoryInfo.d.ts", "releaseTag": "Public", "name": "ElectronMemoryInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMemoryInfo#peakWorkingSetSize:member", "docComment": "/**\n * The maximum amount of memory that has ever been pinned to actual physical RAM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "peakWorkingSetSize: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "peakWorkingSetSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMemoryInfo#privateBytes:member", "docComment": "/**\n * The amount of memory not shared by other processes, such as JS heap or HTML content. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "privateBytes?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "privateBytes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMemoryInfo#workingSetSize:member", "docComment": "/**\n * The amount of memory currently pinned to actual physical RAM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workingSetSize: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "workingSetSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails:interface", "docComment": "/**\n * Usage information for one of Blink's internal memory caches.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMemoryUsageDetails " } ], "fileUrlPath": "src/electron/internals/ElectronMemoryUsageDetails.d.ts", "releaseTag": "Public", "name": "ElectronMemoryUsageDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails#count:member", "docComment": "/**\n * The number of objects in the cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "count: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "count", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails#liveSize:member", "docComment": "/**\n * The size of the live objects in the cache, in bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "liveSize: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "liveSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails#size:member", "docComment": "/**\n * The total size of the cache, in bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "size", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronMenu:class", "docComment": "/**\n * Electron Menu for creating native application menus and context menus.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronMenu " } ], "fileUrlPath": "src/electron/internals/ElectronMenu.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronMenu", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronMenu:constructor(1)", "docComment": "/**\n * Create a new instance of {@link ElectronMenu}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor();" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [] }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#addListener:member(1)", "docComment": "/**\n * Registers an event listener that is invoked when a popup is closed either manually or with {@link ElectronMenu.closePopup}.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This menu instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'menu-will-close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#addListener:member(2)", "docComment": "/**\n * Registers an event listener that is invoked when {@link ElectronMenu.popup} is called.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This menu instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'menu-will-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#append:member(1)", "docComment": "/**\n * Appends the `menuItem` to the menu.\n *\n * @param menuItem - The menu item to append.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "append(menuItem: " }, { "kind": "Reference", "text": "ElectronMenuItem", "canonicalReference": "obsidian-typings!ElectronMenuItem:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "menuItem", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "append" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu.buildFromTemplate:member(1)", "docComment": "/**\n * Generally, the `template` is an array of options for constructing a menu item.\n *\n * You can also attach other fields to the elements of the `template` and they will become properties of the constructed menu items.\n *\n * @param template - The template describing the menu items.\n *\n * @returns The constructed menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static buildFromTemplate(template: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronMenuItem", "canonicalReference": "obsidian-typings!ElectronMenuItem:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronMenuItemConstructorOptions", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "template", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "buildFromTemplate" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#closePopup:member(1)", "docComment": "/**\n * Closes the context menu in the `browserWindow`.\n *\n * @param browserWindow - The window to close the popup in.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closePopup(browserWindow?: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "closePopup" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu.getApplicationMenu:member(1)", "docComment": "/**\n * Returns the application menu, if set, or `null`, if not set.\n *\n * The returned menu instance doesn't support dynamic addition or removal of menu items. Instance properties can still be dynamically modified.\n *\n * @returns The application menu, or `null` if not set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static getApplicationMenu(): " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getApplicationMenu" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#getMenuItemById:member(1)", "docComment": "/**\n * Returns the item with the specified `id`.\n *\n * @param id - The id of the menu item.\n *\n * @returns The matching menu item, or `null` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMenuItemById(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronMenuItem", "canonicalReference": "obsidian-typings!ElectronMenuItem:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getMenuItemById" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#insert:member(1)", "docComment": "/**\n * Inserts the `menuItem` to the `pos` position of the menu.\n *\n * @param pos - The position to insert at.\n *\n * @param menuItem - The menu item to insert.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insert(pos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", menuItem: " }, { "kind": "Reference", "text": "ElectronMenuItem", "canonicalReference": "obsidian-typings!ElectronMenuItem:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "menuItem", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "insert" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenu#items:member", "docComment": "/**\n * A `MenuItem[]` array containing the menu's items.\n *\n * Each menu consists of multiple menu items and each menu item can have a submenu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "ElectronMenuItem", "canonicalReference": "obsidian-typings!ElectronMenuItem:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#on:member(1)", "docComment": "/**\n * Registers an event listener that is invoked when a popup is closed either manually or with {@link ElectronMenu.closePopup}.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This menu instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'menu-will-close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#on:member(2)", "docComment": "/**\n * Registers an event listener that is invoked when {@link ElectronMenu.popup} is called.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This menu instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'menu-will-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#once:member(1)", "docComment": "/**\n * Registers a one-time event listener that is invoked when a popup is closed either manually or with {@link ElectronMenu.closePopup}.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This menu instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'menu-will-close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#once:member(2)", "docComment": "/**\n * Registers a one-time event listener that is invoked when {@link ElectronMenu.popup} is called.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This menu instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'menu-will-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#popup:member(1)", "docComment": "/**\n * Pops up this menu as a context menu in the `BrowserWindow`.\n *\n * @param options - Options for the popup including `window`, `x`, and `y`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "popup(options?: " }, { "kind": "Reference", "text": "ElectronMenuPopupOptions", "canonicalReference": "obsidian-typings!ElectronMenuPopupOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "popup" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#removeListener:member(1)", "docComment": "/**\n * Removes the event listener for a menu popup being closed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This menu instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'menu-will-close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu#removeListener:member(2)", "docComment": "/**\n * Removes the event listener for a menu popup being shown.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This menu instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'menu-will-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu.sendActionToFirstResponder:member(1)", "docComment": "/**\n * Sends the `action` to the first responder of application. This is used for emulating default macOS menu behaviors. Usually you would use the `role` property of a menu item. `darwin` only.\n *\n * @param action - The action to send to the first responder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static sendActionToFirstResponder(action: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "sendActionToFirstResponder" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenu.setApplicationMenu:member(1)", "docComment": "/**\n * Sets `menu` as the application menu on macOS. On Windows and Linux, the `menu` will be set as each window's top menu.\n *\n * Passing `null` will suppress the default menu. On Windows and Linux, this has the additional effect of removing the menu bar from the window.\n *\n * @param menu - The menu to set, or `null` to suppress the default menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static setApplicationMenu(menu: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setApplicationMenu" } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronMenuItem:class", "docComment": "/**\n * Electron MenuItem for adding items to native application menus.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronMenuItem " } ], "fileUrlPath": "src/electron/internals/ElectronMenuItem.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronMenuItem", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronMenuItem:constructor(1)", "docComment": "/**\n * Creates a new menu item.\n *\n * @param options - The menu item options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronMenuItemConstructorOptions", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#accelerator:member", "docComment": "/**\n * The item's accelerator, if set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accelerator?: " }, { "kind": "Reference", "text": "ElectronAccelerator", "canonicalReference": "obsidian-typings!ElectronAccelerator:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "accelerator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#checked:member", "docComment": "/**\n * Whether the item is checked. This property can be dynamically changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checked: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "checked", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronMenuItem#click:member(1)", "docComment": "/**\n * The click handler that is fired when the menu item receives a click event.\n *\n * @param menuItem - The menu item that was clicked.\n *\n * @param browserWindow - The focused window, or `undefined` if none.\n *\n * @param event - The keyboard event associated with the click.\n *\n * @returns Nothing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "click(menuItem: " }, { "kind": "Reference", "text": "ElectronMenuItem", "canonicalReference": "obsidian-typings!ElectronMenuItem:class" }, { "kind": "Content", "text": ", browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ", event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "menuItem", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "click" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#commandId:member", "docComment": "/**\n * An item's sequential unique id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commandId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "commandId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#enabled:member", "docComment": "/**\n * Whether the item is enabled. This property can be dynamically changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#icon:member", "docComment": "/**\n * The item's icon, if set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#id:member", "docComment": "/**\n * The item's unique id. This property can be dynamically changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#label:member", "docComment": "/**\n * The item's visible label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#menu:member", "docComment": "/**\n * The menu that the item is a part of.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "menu: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "menu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#registerAccelerator:member", "docComment": "/**\n * Whether the accelerator should be registered with the system or just displayed. This property can be dynamically changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerAccelerator: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "registerAccelerator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#role:member", "docComment": "/**\n * The item's role, if set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "role?: " }, { "kind": "Content", "text": "'about' | 'appMenu' | 'clearRecentDocuments' | 'close' | 'copy' | 'cut' | 'delete' | 'editMenu' | 'fileMenu' | 'forceReload' | 'front' | 'help' | 'hide' | 'hideOthers' | 'mergeAllWindows' | 'minimize' | 'moveTabToNewWindow' | 'paste' | 'pasteAndMatchStyle' | 'quit' | 'recentDocuments' | 'redo' | 'reload' | 'resetZoom' | 'selectAll' | 'selectNextTab' | 'selectPreviousTab' | 'services' | 'shareMenu' | 'startSpeaking' | 'stopSpeaking' | 'toggleDevTools' | 'togglefullscreen' | 'toggleSpellChecker' | 'toggleTabBar' | 'undo' | 'unhide' | 'viewMenu' | 'window' | 'windowMenu' | 'zoom' | 'zoomIn' | 'zoomOut'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "role", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#sharingItem:member", "docComment": "/**\n * The item to share when the `role` is `shareMenu`. This property can be dynamically changed. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sharingItem: " }, { "kind": "Reference", "text": "ElectronSharingItem", "canonicalReference": "obsidian-typings!ElectronSharingItem:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sharingItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#sublabel:member", "docComment": "/**\n * The item's sublabel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sublabel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sublabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#submenu:member", "docComment": "/**\n * The menu item's submenu, if present.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "submenu?: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "submenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#toolTip:member", "docComment": "/**\n * The item's hover text. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toolTip: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toolTip", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#type:member", "docComment": "/**\n * The type of the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'checkbox' | 'normal' | 'radio' | 'separator' | 'submenu'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#userAccelerator:member", "docComment": "/**\n * The item's user-assigned accelerator for the menu item. Only initialized after the item has been added to a menu; accessing before initialization returns `null`. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly userAccelerator: " }, { "kind": "Reference", "text": "ElectronAccelerator", "canonicalReference": "obsidian-typings!ElectronAccelerator:type" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "userAccelerator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMenuItem#visible:member", "docComment": "/**\n * Whether the item is visible. This property can be dynamically changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "visible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "visible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions:interface", "docComment": "/**\n * Options for constructing an Electron {@link ElectronMenuItem}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMenuItemConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronMenuItemConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronMenuItemConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#accelerator:member", "docComment": "/**\n * The item's accelerator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accelerator?: " }, { "kind": "Reference", "text": "ElectronAccelerator", "canonicalReference": "obsidian-typings!ElectronAccelerator:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "accelerator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#acceleratorWorksWhenHidden:member", "docComment": "/**\n * When `false`, prevents the accelerator from triggering the item if the item is not visible. `darwin` only.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "acceleratorWorksWhenHidden?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "acceleratorWorksWhenHidden", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#after:member", "docComment": "/**\n * Inserts this item after the item with the specified label. If the referenced item doesn't exist the item will be inserted at the end of the menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "after?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "after", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#afterGroupContaining:member", "docComment": "/**\n * Declares the placement of this item's containing group after the containing group of the item with the specified label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "afterGroupContaining?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "afterGroupContaining", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#before:member", "docComment": "/**\n * Inserts this item before the item with the specified label. If the referenced item doesn't exist the item will be inserted at the end of the menu. Also implies that the item should be placed in the same group as the referenced item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "before?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "before", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#beforeGroupContaining:member", "docComment": "/**\n * Declares the placement of this item's containing group before the containing group of the item with the specified label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "beforeGroupContaining?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "beforeGroupContaining", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#checked:member", "docComment": "/**\n * Should only be specified for `checkbox` or `radio` type menu items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checked?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "checked", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#click:member(1)", "docComment": "/**\n * Will be called when the menu item is clicked.\n *\n * @param menuItem - The menu item that was clicked.\n *\n * @param browserWindow - The focused window, or `undefined` if none.\n *\n * @param event - The keyboard event associated with the click.\n *\n * @returns Nothing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "click?(menuItem: " }, { "kind": "Reference", "text": "ElectronMenuItem", "canonicalReference": "obsidian-typings!ElectronMenuItem:class" }, { "kind": "Content", "text": ", browserWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ", event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menuItem", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false } ], "name": "click" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#enabled:member", "docComment": "/**\n * If `false`, the menu item will be greyed out and unclickable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#icon:member", "docComment": "/**\n * The item's icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#id:member", "docComment": "/**\n * Unique within a single menu. If defined then it can be used as a reference to this item by the position attribute.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#label:member", "docComment": "/**\n * The item's visible label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#registerAccelerator:member", "docComment": "/**\n * If `false`, the accelerator won't be registered with the system, but it will still be displayed. `linux`/`win32` only.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerAccelerator?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "registerAccelerator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#role:member", "docComment": "/**\n * Defines the action of the menu item. When specified the `click` property will be ignored.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "role?: " }, { "kind": "Content", "text": "'about' | 'appMenu' | 'clearRecentDocuments' | 'close' | 'copy' | 'cut' | 'delete' | 'editMenu' | 'fileMenu' | 'forceReload' | 'front' | 'help' | 'hide' | 'hideOthers' | 'mergeAllWindows' | 'minimize' | 'moveTabToNewWindow' | 'paste' | 'pasteAndMatchStyle' | 'quit' | 'recentDocuments' | 'redo' | 'reload' | 'resetZoom' | 'selectAll' | 'selectNextTab' | 'selectPreviousTab' | 'services' | 'shareMenu' | 'showSubstitutions' | 'startSpeaking' | 'stopSpeaking' | 'toggleDevTools' | 'togglefullscreen' | 'toggleSmartDashes' | 'toggleSmartQuotes' | 'toggleSpellChecker' | 'toggleTabBar' | 'toggleTextReplacement' | 'undo' | 'unhide' | 'viewMenu' | 'window' | 'windowMenu' | 'zoom' | 'zoomIn' | 'zoomOut'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "role", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#sharingItem:member", "docComment": "/**\n * The item to share when the `role` is `shareMenu`. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sharingItem?: " }, { "kind": "Reference", "text": "ElectronSharingItem", "canonicalReference": "obsidian-typings!ElectronSharingItem:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sharingItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#sublabel:member", "docComment": "/**\n * The item's sublabel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sublabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sublabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#submenu:member", "docComment": "/**\n * Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted. If the value is not a menu then it will be automatically converted to one using `Menu.buildFromTemplate`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "submenu?: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronMenuItemConstructorOptions", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "submenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#toolTip:member", "docComment": "/**\n * Hover text for this menu item. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toolTip?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toolTip", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#type:member", "docComment": "/**\n * The type of the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Content", "text": "'checkbox' | 'normal' | 'radio' | 'separator' | 'submenu'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuItemConstructorOptions#visible:member", "docComment": "/**\n * If `false`, the menu item will be entirely hidden.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "visible?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "visible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMenuPopupOptions:interface", "docComment": "/**\n * Options for popping up a context menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMenuPopupOptions " } ], "fileUrlPath": "src/electron/internals/ElectronMenuPopupOptions.d.ts", "releaseTag": "Public", "name": "ElectronMenuPopupOptions", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMenuPopupOptions#callback:member(1)", "docComment": "/**\n * Called when the menu is closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "callback?(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "callback" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuPopupOptions#positioningItem:member", "docComment": "/**\n * The index of the menu item to be positioned under the mouse cursor at the specified coordinates. `darwin` only.\n *\n * @default\n *\n * `-1`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "positioningItem?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "positioningItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuPopupOptions#window:member", "docComment": "/**\n * The window to show the popup in. When omitted, the focused window is used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "window?: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "window", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuPopupOptions#x:member", "docComment": "/**\n * The x coordinate. Must be declared if `y` is declared. When omitted, the current mouse cursor position is used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMenuPopupOptions#y:member", "docComment": "/**\n * The y coordinate. Must be declared if `x` is declared. When omitted, the current mouse cursor position is used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions:interface", "docComment": "/**\n * Options for Electron message box dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMessageBoxOptions " } ], "fileUrlPath": "src/electron/internals/ElectronMessageBoxOptions.d.ts", "releaseTag": "Public", "name": "ElectronMessageBoxOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#buttons:member", "docComment": "/**\n * The array of button labels. On Windows, an empty array will result in one button labeled `OK`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttons?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "buttons", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#cancelId:member", "docComment": "/**\n * The index of the button to be used to cancel the dialog.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancelId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cancelId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#checkboxChecked:member", "docComment": "/**\n * The initial checked state of the checkbox.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkboxChecked?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "checkboxChecked", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#checkboxLabel:member", "docComment": "/**\n * The label for the checkbox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkboxLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "checkboxLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#defaultId:member", "docComment": "/**\n * The index of the button that is selected by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#detail:member", "docComment": "/**\n * Extra information about the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detail?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "detail", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#icon:member", "docComment": "/**\n * The icon to display in the message box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#message:member", "docComment": "/**\n * The content of the message box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#noLink:member", "docComment": "/**\n * Whether to set the no link flag for the message box on Windows.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "noLink?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "noLink", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#normalizeAccessKeys:member", "docComment": "/**\n * Whether to normalize keyboard access keys across platforms.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "normalizeAccessKeys?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "normalizeAccessKeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#signal:member", "docComment": "/**\n * An `AbortSignal` to optionally close the message box, behaving as if it was cancelled by the user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "signal?: " }, { "kind": "Reference", "text": "AbortSignal", "canonicalReference": "!AbortSignal:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "signal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#textWidth:member", "docComment": "/**\n * Custom width of the text in the message box (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textWidth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "textWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#title:member", "docComment": "/**\n * The title of the message box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxOptions#type:member", "docComment": "/**\n * The type of the message box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Content", "text": "'error' | 'info' | 'none' | 'question' | 'warning'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMessageBoxReturnValue:interface", "docComment": "/**\n * Return value from an Electron message box dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMessageBoxReturnValue " } ], "fileUrlPath": "src/electron/internals/ElectronMessageBoxReturnValue.d.ts", "releaseTag": "Public", "name": "ElectronMessageBoxReturnValue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxReturnValue#checkboxChecked:member", "docComment": "/**\n * Whether the checkbox was checked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkboxChecked: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "checkboxChecked", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxReturnValue#response:member", "docComment": "/**\n * The index of the clicked button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "response: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "response", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions:interface", "docComment": "/**\n * Options for Electron synchronous message box dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMessageBoxSyncOptions " } ], "fileUrlPath": "src/electron/internals/ElectronMessageBoxSyncOptions.d.ts", "releaseTag": "Public", "name": "ElectronMessageBoxSyncOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#buttons:member", "docComment": "/**\n * The array of button labels. On Windows, an empty array will result in one button labeled `OK`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttons?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "buttons", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#cancelId:member", "docComment": "/**\n * The index of the button to be used to cancel the dialog.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancelId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cancelId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#defaultId:member", "docComment": "/**\n * The index of the button that is selected by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#detail:member", "docComment": "/**\n * Extra information about the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detail?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "detail", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#icon:member", "docComment": "/**\n * The icon to display in the message box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#message:member", "docComment": "/**\n * The content of the message box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#noLink:member", "docComment": "/**\n * Whether to set the no link flag for the message box on Windows.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "noLink?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "noLink", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#normalizeAccessKeys:member", "docComment": "/**\n * Whether to normalize keyboard access keys across platforms.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "normalizeAccessKeys?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "normalizeAccessKeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#textWidth:member", "docComment": "/**\n * Custom width of the text in the message box (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textWidth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "textWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#title:member", "docComment": "/**\n * The title of the message box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageBoxSyncOptions#type:member", "docComment": "/**\n * The type of the message box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Content", "text": "'error' | 'info' | 'none' | 'question' | 'warning'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronMessageChannelMain:class", "docComment": "/**\n * A main-process channel that owns a pair of connected {@link ElectronMessagePortMain} ports.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronMessageChannelMain " } ], "fileUrlPath": "src/electron/internals/ElectronMessageChannelMain.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronMessageChannelMain", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronMessageChannelMain:constructor(1)", "docComment": "/**\n * Create a new instance of {@link ElectronMessageChannelMain}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor();" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMessageChannelMain#port1:member", "docComment": "/**\n * One of the two connected `MessagePortMain` ports of this channel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "port1: " }, { "kind": "Reference", "text": "ElectronMessagePortMain", "canonicalReference": "obsidian-typings!ElectronMessagePortMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "port1", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronMessageChannelMain#port2:member", "docComment": "/**\n * The other of the two connected `MessagePortMain` ports of this channel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "port2: " }, { "kind": "Reference", "text": "ElectronMessagePortMain", "canonicalReference": "obsidian-typings!ElectronMessagePortMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "port2", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMessageDetails:interface", "docComment": "/**\n * Details of a console message logged by a service worker.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMessageDetails " } ], "fileUrlPath": "src/electron/internals/ElectronMessageDetails.d.ts", "releaseTag": "Public", "name": "ElectronMessageDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageDetails#level:member", "docComment": "/**\n * The log level, from 0 to 3, matching `verbose`, `info`, `warning` and `error`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "level: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "level", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageDetails#lineNumber:member", "docComment": "/**\n * The line number of the source that triggered this console message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineNumber: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageDetails#message:member", "docComment": "/**\n * The actual console message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageDetails#source:member", "docComment": "/**\n * The type of source for this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "source: " }, { "kind": "Content", "text": "'console-api' | 'deprecation' | 'intervention' | 'javascript' | 'network' | 'other' | 'recommendation' | 'rendering' | 'security' | 'storage' | 'violation' | 'worker' | 'xml'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageDetails#sourceUrl:member", "docComment": "/**\n * The URL the message came from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourceUrl: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sourceUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageDetails#versionId:member", "docComment": "/**\n * The version ID of the service worker that sent the log message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "versionId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "versionId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMessageEvent:interface", "docComment": "/**\n * Event emitted when a `MessagePortMain` receives a message.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMessageEvent " } ], "fileUrlPath": "src/electron/internals/ElectronMessageEvent.d.ts", "releaseTag": "Public", "name": "ElectronMessageEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageEvent#data:member", "docComment": "/**\n * The message payload.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMessageEvent#ports:member", "docComment": "/**\n * The message ports transferred with the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ports: " }, { "kind": "Reference", "text": "ElectronMessagePortMain", "canonicalReference": "obsidian-typings!ElectronMessagePortMain:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ports", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMessagePortMain:interface", "docComment": "/**\n * The main-process end of a MessagePort channel.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMessagePortMain " } ], "fileUrlPath": "src/electron/internals/ElectronMessagePortMain.d.ts", "releaseTag": "Public", "name": "ElectronMessagePortMain", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#addListener:member(1)", "docComment": "/**\n * Registers a listener for the `close` event, emitted when the remote end becomes disconnected.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the port closes.\n *\n * @returns This message port instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#addListener:member(2)", "docComment": "/**\n * Registers a listener for the `message` event, emitted when the port receives a message.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the received message event.\n *\n * @returns This message port instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(messageEvent: " }, { "kind": "Reference", "text": "ElectronMessageEvent", "canonicalReference": "obsidian-typings!ElectronMessageEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#close:member(1)", "docComment": "/**\n * Disconnects the port, so it is no longer active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "close" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#on:member(1)", "docComment": "/**\n * Registers a listener for the `close` event, emitted when the remote end becomes disconnected.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the port closes.\n *\n * @returns This message port instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#on:member(2)", "docComment": "/**\n * Registers a listener for the `message` event, emitted when the port receives a message.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the received message event.\n *\n * @returns This message port instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(messageEvent: " }, { "kind": "Reference", "text": "ElectronMessageEvent", "canonicalReference": "obsidian-typings!ElectronMessageEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `close` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the port closes.\n *\n * @returns This message port instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the received message event.\n *\n * @returns This message port instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(messageEvent: " }, { "kind": "Reference", "text": "ElectronMessageEvent", "canonicalReference": "obsidian-typings!ElectronMessageEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#postMessage:member(1)", "docComment": "/**\n * Sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.\n *\n * @param message - The message to send.\n *\n * @param transfer - Message ports whose ownership is transferred with the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postMessage(message: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", transfer?: " }, { "kind": "Reference", "text": "ElectronMessagePortMain", "canonicalReference": "obsidian-typings!ElectronMessagePortMain:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "transfer", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": true } ], "name": "postMessage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#removeListener:member(1)", "docComment": "/**\n * Removes a previously registered `close` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This message port instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#removeListener:member(2)", "docComment": "/**\n * Removes a previously registered `message` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This message port instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(messageEvent: " }, { "kind": "Reference", "text": "ElectronMessageEvent", "canonicalReference": "obsidian-typings!ElectronMessageEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMessagePortMain#start:member(1)", "docComment": "/**\n * Starts the sending of messages queued on the port. Messages will be queued until this method is called.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "start" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronModule:interface", "docComment": "/**\n * The Electron library module type, representing the `window.electron` object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronModule " } ], "fileUrlPath": "src/electron/internals/ElectronModule.d.ts", "releaseTag": "Public", "name": "ElectronModule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronModule#clipboard:member", "docComment": "/**\n * Electron clipboard instance for accessing the system clipboard.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clipboard: " }, { "kind": "Reference", "text": "ElectronClipboard", "canonicalReference": "obsidian-typings!ElectronClipboard:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clipboard", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronModule#contextBridge:member", "docComment": "/**\n * Electron `contextBridge` module for exposing APIs across isolated worlds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contextBridge: " }, { "kind": "Reference", "text": "ElectronContextBridge", "canonicalReference": "obsidian-typings!ElectronContextBridge:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contextBridge", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronModule#crashReporter:member", "docComment": "/**\n * Electron `crashReporter` module for submitting crash reports.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "crashReporter: " }, { "kind": "Reference", "text": "ElectronCrashReporter", "canonicalReference": "obsidian-typings!ElectronCrashReporter:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "crashReporter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronModule#ipcRenderer:member", "docComment": "/**\n * Electron IPC renderer instance for the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ipcRenderer: " }, { "kind": "Reference", "text": "ElectronIpcRenderer", "canonicalReference": "obsidian-typings!ElectronIpcRenderer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ipcRenderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronModule#nativeImage:member", "docComment": "/**\n * Electron `nativeImage` module for creating images from files, buffers, and data URLs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nativeImage: " }, { "kind": "Reference", "text": "ElectronNativeImageModule", "canonicalReference": "obsidian-typings!ElectronNativeImageModule:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nativeImage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronModule#remote:member", "docComment": "/**\n * Electron remote module instance for accessing main process modules.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remote: " }, { "kind": "Reference", "text": "ElectronRemote", "canonicalReference": "obsidian-typings!ElectronRemote:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "remote", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronModule#shell:member", "docComment": "/**\n * Electron shell instance for managing files and URLs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shell: " }, { "kind": "Reference", "text": "ElectronShell", "canonicalReference": "obsidian-typings!ElectronShell:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "shell", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronModule#webFrame:member", "docComment": "/**\n * Electron `webFrame` module for controlling the current renderer frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webFrame: " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webFrame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent:interface", "docComment": "/**\n * Mouse input event passed to {@link ElectronWebContents.sendInputEvent} to inject a trusted pointer event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMouseInputEvent extends " }, { "kind": "Reference", "text": "ElectronInputEvent", "canonicalReference": "obsidian-typings!ElectronInputEvent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronMouseInputEvent.d.ts", "releaseTag": "Public", "name": "ElectronMouseInputEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#button:member", "docComment": "/**\n * The button pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "button?: " }, { "kind": "Content", "text": "'left' | 'middle' | 'right'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "button", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#clickCount:member", "docComment": "/**\n * The number of consecutive clicks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clickCount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "clickCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#globalX:member", "docComment": "/**\n * The x coordinate of the pointer relative to the screen.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "globalX?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "globalX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#globalY:member", "docComment": "/**\n * The y coordinate of the pointer relative to the screen.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "globalY?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "globalY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#movementX:member", "docComment": "/**\n * The x movement delta since the previous mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "movementX?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "movementX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#movementY:member", "docComment": "/**\n * The y movement delta since the previous mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "movementY?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "movementY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#type:member", "docComment": "/**\n * The type of the mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'contextMenu' | 'mouseDown' | 'mouseEnter' | 'mouseLeave' | 'mouseMove' | 'mouseUp' | 'mouseWheel'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#x:member", "docComment": "/**\n * The x coordinate (web-contents DIP) of the pointer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent#y:member", "docComment": "/**\n * The y coordinate (web-contents DIP) of the pointer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent:interface", "docComment": "/**\n * Mouse wheel input event passed to {@link ElectronWebContents.sendInputEvent} to inject a trusted scroll.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMouseWheelInputEvent extends " }, { "kind": "Reference", "text": "ElectronMouseInputEvent", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronMouseWheelInputEvent.d.ts", "releaseTag": "Public", "name": "ElectronMouseWheelInputEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#accelerationRatioX:member", "docComment": "/**\n * The acceleration ratio along the x axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accelerationRatioX?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "accelerationRatioX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#accelerationRatioY:member", "docComment": "/**\n * The acceleration ratio along the y axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accelerationRatioY?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "accelerationRatioY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#canScroll:member", "docComment": "/**\n * Whether the wheel event can trigger scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canScroll?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "canScroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#deltaX:member", "docComment": "/**\n * The scroll delta along the x axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deltaX?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "deltaX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#deltaY:member", "docComment": "/**\n * The scroll delta along the y axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deltaY?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "deltaY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#hasPreciseScrollingDeltas:member", "docComment": "/**\n * Whether the event carries precise scrolling deltas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasPreciseScrollingDeltas?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hasPreciseScrollingDeltas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#type:member", "docComment": "/**\n * The type of the mouse wheel event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'mouseWheel'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#wheelTicksX:member", "docComment": "/**\n * The number of wheel ticks along the x axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wheelTicksX?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "wheelTicksX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent#wheelTicksY:member", "docComment": "/**\n * The number of wheel ticks along the y axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wheelTicksY?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "wheelTicksY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronMoveToApplicationsFolderOptions:interface", "docComment": "/**\n * Options for moving the application into the Applications folder.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronMoveToApplicationsFolderOptions " } ], "fileUrlPath": "src/electron/internals/ElectronMoveToApplicationsFolderOptions.d.ts", "releaseTag": "Public", "name": "ElectronMoveToApplicationsFolderOptions", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronMoveToApplicationsFolderOptions#conflictHandler:member(1)", "docComment": "/**\n * A handler for potential conflict in move failure.\n *\n * @param conflictType - The type of conflict encountered.\n *\n * @returns Whether the move should proceed with the default behavior.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "conflictHandler?(conflictType: " }, { "kind": "Content", "text": "'exists' | 'existsAndRunning'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "conflictType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "conflictHandler" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface", "docComment": "/**\n * Electron NativeImage for handling tray, dock, and application images.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNativeImage " } ], "fileUrlPath": "src/electron/internals/ElectronNativeImage.d.ts", "releaseTag": "Public", "name": "ElectronNativeImage", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#addRepresentation:member(1)", "docComment": "/**\n * Adds an image representation for a specific scale factor. This can be used to explicitly add different scale factor representations to an image. This can be called on empty images.\n *\n * @param options - The image representation to add, including `scaleFactor` and either a `buffer` or `dataURL`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addRepresentation(options: " }, { "kind": "Reference", "text": "ElectronAddRepresentationOptions", "canonicalReference": "obsidian-typings!ElectronAddRepresentationOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addRepresentation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#crop:member(1)", "docComment": "/**\n * Returns a cropped copy of the image.\n *\n * @param rect - The area of the image to crop.\n *\n * @returns The cropped image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "crop(rect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "crop" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#getAspectRatio:member(1)", "docComment": "/**\n * Returns the image's aspect ratio. If `scaleFactor` is passed, this returns the aspect ratio corresponding to the image representation most closely matching the passed value.\n *\n * @param scaleFactor - The scale factor to get the aspect ratio for.\n *\n * @returns The image's aspect ratio.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAspectRatio(scaleFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scaleFactor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getAspectRatio" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#getBitmap:member(1)", "docComment": "/**\n * Returns a buffer that contains the image's raw bitmap pixel data. The difference between `getBitmap()` and `toBitmap()` is that `getBitmap()` does not copy the bitmap data, so the returned buffer must be used immediately in the current event loop tick; otherwise the data might be changed or destroyed.\n *\n * @param options - Options for the bitmap conversion including `scaleFactor`.\n *\n * @returns The image's raw bitmap pixel data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBitmap(options?: " }, { "kind": "Reference", "text": "ElectronNativeImageScaleFactorOptions", "canonicalReference": "obsidian-typings!ElectronNativeImageScaleFactorOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getBitmap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#getNativeHandle:member(1)", "docComment": "/**\n * Returns a buffer that stores the C pointer to the underlying native handle of the image. On macOS, a pointer to an `NSImage` instance is returned. The returned pointer is a weak pointer to the underlying native image, so the associated `nativeImage` instance must be kept around. Only available on macOS.\n *\n * @returns The native handle of the image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNativeHandle(): " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getNativeHandle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#getScaleFactors:member(1)", "docComment": "/**\n * Returns an array of all scale factors corresponding to representations for a given native image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getScaleFactors(): " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getScaleFactors" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#getSize:member(1)", "docComment": "/**\n * Returns the size of the image. If `scaleFactor` is passed, this returns the size corresponding to the image representation most closely matching the passed value.\n *\n * @param scaleFactor - The scale factor to get the size for.\n *\n * @returns The width and height of the image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSize(scaleFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImageSize", "canonicalReference": "obsidian-typings!ElectronNativeImageSize:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scaleFactor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getSize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#isEmpty:member(1)", "docComment": "/**\n * Returns whether the image is empty.\n *\n * @returns Whether the image is empty.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEmpty(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isEmpty" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#isMacTemplateImage:member", "docComment": "/**\n * A `boolean` property that determines whether the image is considered a template image. Only has an effect on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMacTemplateImage: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMacTemplateImage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#isTemplateImage:member(1)", "docComment": "/**\n * Returns whether the image is a template image.\n *\n * @returns Whether the image is a template image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isTemplateImage(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isTemplateImage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#resize:member(1)", "docComment": "/**\n * Returns a resized copy of the image. If only the `height` or the `width` is specified then the current aspect ratio is preserved in the resized image.\n *\n * @param options - Options for the resize including `width`, `height`, and `quality`.\n *\n * @returns The resized image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resize(options: " }, { "kind": "Reference", "text": "ElectronResizeOptions", "canonicalReference": "obsidian-typings!ElectronResizeOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "resize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#setTemplateImage:member(1)", "docComment": "/**\n * Marks the image as a template image.\n *\n * @param option - Whether the image should be marked as a template image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTemplateImage(option: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "option", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setTemplateImage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#toBitmap:member(1)", "docComment": "/**\n * Returns a buffer that contains a copy of the image's raw bitmap pixel data.\n *\n * @param options - Options for the bitmap conversion including `scaleFactor`.\n *\n * @returns The bitmap buffer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toBitmap(options?: " }, { "kind": "Reference", "text": "ElectronNativeImageScaleFactorOptions", "canonicalReference": "obsidian-typings!ElectronNativeImageScaleFactorOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "toBitmap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#toDataURL:member(1)", "docComment": "/**\n * Returns the data URL of the image.\n *\n * @param options - Options for the conversion including `scaleFactor`.\n *\n * @returns The data URL string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toDataURL(options?: " }, { "kind": "Reference", "text": "ElectronNativeImageScaleFactorOptions", "canonicalReference": "obsidian-typings!ElectronNativeImageScaleFactorOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "toDataURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#toJPEG:member(1)", "docComment": "/**\n * Returns a buffer that contains the image's `JPEG` encoded data.\n *\n * @param quality - The JPEG quality between `0` and `100`.\n *\n * @returns The JPEG buffer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toJPEG(quality: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "quality", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toJPEG" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImage#toPNG:member(1)", "docComment": "/**\n * Returns a buffer that contains the image's `PNG` encoded data.\n *\n * @param options - Options for the PNG conversion including `scaleFactor`.\n *\n * @returns The PNG buffer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toPNG(options?: " }, { "kind": "Reference", "text": "ElectronNativeImageScaleFactorOptions", "canonicalReference": "obsidian-typings!ElectronNativeImageScaleFactorOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "toPNG" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNativeImageModule:interface", "docComment": "/**\n * Electron nativeImage module for creating tray, dock, and application images from various sources.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNativeImageModule " } ], "fileUrlPath": "src/electron/internals/ElectronNativeImageModule.d.ts", "releaseTag": "Public", "name": "ElectronNativeImageModule", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImageModule#createEmpty:member(1)", "docComment": "/**\n * Creates an empty `NativeImage` instance.\n *\n * @returns An empty image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createEmpty(): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "createEmpty" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImageModule#createFromBitmap:member(1)", "docComment": "/**\n * Creates a new `NativeImage` instance from `buffer` that contains the raw bitmap pixel data returned by `toBitmap()`. The specific format is platform-dependent.\n *\n * @param buffer - The raw bitmap pixel data.\n *\n * @param options - Options describing the bitmap dimensions and scale factor.\n *\n * @returns The created image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFromBitmap(buffer: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronCreateFromBitmapOptions", "canonicalReference": "obsidian-typings!ElectronCreateFromBitmapOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "buffer", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "createFromBitmap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImageModule#createFromBuffer:member(1)", "docComment": "/**\n * Creates a new `NativeImage` instance from `buffer`. Tries to decode as PNG or JPEG first.\n *\n * @param buffer - The image data to decode.\n *\n * @param options - Options describing the image dimensions and scale factor.\n *\n * @returns The created image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFromBuffer(buffer: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronCreateFromBufferOptions", "canonicalReference": "obsidian-typings!ElectronCreateFromBufferOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "buffer", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "createFromBuffer" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImageModule#createFromDataURL:member(1)", "docComment": "/**\n * Creates a new `NativeImage` instance from `dataURL`.\n *\n * @param dataURL - The data URL to create the image from.\n *\n * @returns The created image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFromDataURL(dataURL: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "dataURL", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createFromDataURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImageModule#createFromNamedImage:member(1)", "docComment": "/**\n * Creates a new `NativeImage` instance from the `NSImage` that maps to the given image name. Only available on macOS.\n *\n * @param imageName - The name of the system image.\n *\n * @param hslShift - An HSL shift applied to the image, as `[hue, saturation, lightness]`.\n *\n * @returns The created image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFromNamedImage(imageName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", hslShift?: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "imageName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "hslShift", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "createFromNamedImage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImageModule#createFromPath:member(1)", "docComment": "/**\n * Creates a new `NativeImage` instance from a file located at `path`. This method returns an empty image if the `path` does not exist, cannot be read, or is not a valid image.\n *\n * @param path - The path to the image file.\n *\n * @returns The created image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFromPath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createFromPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeImageModule#createThumbnailFromPath:member(1)", "docComment": "/**\n * Creates a thumbnail preview image for the file at `path`. Only available on macOS and Windows.\n *\n * @param path - The path to the file to create a thumbnail for.\n *\n * @param maxSize - The maximum size of the thumbnail.\n *\n * @returns A promise that fulfills with the file's thumbnail preview image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createThumbnailFromPath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", maxSize: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "maxSize", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "createThumbnailFromPath" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNativeImageScaleFactorOptions:interface", "docComment": "/**\n * Options for NativeImage scale factor operations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNativeImageScaleFactorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronNativeImageScaleFactorOptions.d.ts", "releaseTag": "Public", "name": "ElectronNativeImageScaleFactorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeImageScaleFactorOptions#scaleFactor:member", "docComment": "/**\n * The scale factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNativeImageSize:interface", "docComment": "/**\n * The size of a NativeImage.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNativeImageSize " } ], "fileUrlPath": "src/electron/internals/ElectronNativeImageSize.d.ts", "releaseTag": "Public", "name": "ElectronNativeImageSize", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeImageSize#height:member", "docComment": "/**\n * The height of the image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeImageSize#width:member", "docComment": "/**\n * The width of the image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNativeTheme:interface", "docComment": "/**\n * Electron NativeTheme for reading and updating the system's theme preferences.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNativeTheme " } ], "fileUrlPath": "src/electron/internals/ElectronNativeTheme.d.ts", "releaseTag": "Public", "name": "ElectronNativeTheme", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#addListener:member(1)", "docComment": "/**\n * Adds a listener for the `updated` event.\n *\n * Emitted when something in the underlying `NativeTheme` has changed. This normally means that either the value of `shouldUseDarkColors`, `shouldUseHighContrastColors` or `shouldUseInvertedColorScheme` has changed. You will have to check them to determine which one has changed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronNativeTheme` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#inForcedColorsMode:member", "docComment": "/**\n * A `boolean` indicating whether Chromium is in forced colors mode, controlled by system accessibility settings. Currently, Windows high contrast is the only system setting that triggers forced colors mode.\n *\n * Platform: `win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly inForcedColorsMode: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "inForcedColorsMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#on:member(1)", "docComment": "/**\n * Registers a listener for the `updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronNativeTheme` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `updated` event. The listener is removed after it is invoked once.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronNativeTheme` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#removeListener:member(1)", "docComment": "/**\n * Removes the specified listener for the `updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This `ElectronNativeTheme` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#shouldUseDarkColors:member", "docComment": "/**\n * A `boolean` for if the OS / Chromium currently has a dark mode enabled or is being instructed to show a dark-style UI. If you want to modify this value you should use `themeSource` below.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly shouldUseDarkColors: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "shouldUseDarkColors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#shouldUseHighContrastColors:member", "docComment": "/**\n * A `boolean` for if the OS / Chromium currently has high-contrast mode enabled or is being instructed to show a high-contrast UI.\n *\n * Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly shouldUseHighContrastColors: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "shouldUseHighContrastColors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#shouldUseInvertedColorScheme:member", "docComment": "/**\n * A `boolean` for if the OS / Chromium currently has an inverted color scheme or is being instructed to use an inverted color scheme.\n *\n * Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly shouldUseInvertedColorScheme: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "shouldUseInvertedColorScheme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNativeTheme#themeSource:member", "docComment": "/**\n * A `string` property that can be `system`, `light` or `dark`. It is used to override and supersede the value that Chromium has chosen to use internally. Setting this property to `system` will remove the override and everything will be reset to the OS default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "themeSource: " }, { "kind": "Content", "text": "'dark' | 'light' | 'system'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "themeSource", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNet:interface", "docComment": "/**\n * Issues HTTP/HTTPS requests using Chromium's native networking library.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNet " } ], "fileUrlPath": "src/electron/internals/ElectronNet.d.ts", "releaseTag": "Public", "name": "ElectronNet", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNet#isOnline:member(1)", "docComment": "/**\n * Whether there is currently internet connection.\n *\n * A return value of `false` is a pretty strong indicator that the user won't be able to connect to remote sites. However, a return value of `true` is inconclusive; even if some link is up, it is uncertain whether a particular connection attempt to a particular remote site will be successful.\n *\n * @returns Whether there is currently internet connection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isOnline(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isOnline" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNet#online:member", "docComment": "/**\n * A `boolean` property. Whether there is currently internet connection.\n *\n * A return value of `false` is a pretty strong indicator that the user won't be able to connect to remote sites. However, a return value of `true` is inconclusive; even if some link is up, it is uncertain whether a particular connection attempt to a particular remote site will be successful.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly online: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "online", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNet#request:member(1)", "docComment": "/**\n * Creates a `ClientRequest` instance using the provided `options` which are directly forwarded to the `ClientRequest` constructor. The `net.request` method would be used to issue both secure and insecure HTTP requests according to the specified protocol scheme in the `options` object.\n *\n * @param options - The request options, or the request URL as a string.\n *\n * @returns The created request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "request(options: " }, { "kind": "Reference", "text": "ElectronClientRequestConstructorOptions", "canonicalReference": "obsidian-typings!ElectronClientRequestConstructorOptions:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronClientRequest", "canonicalReference": "obsidian-typings!ElectronClientRequest:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "request" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNetLog:interface", "docComment": "/**\n * Records network events for a session to a file for later analysis.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNetLog " } ], "fileUrlPath": "src/electron/internals/ElectronNetLog.d.ts", "releaseTag": "Public", "name": "ElectronNetLog", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNetLog#currentlyLogging:member", "docComment": "/**\n * Whether network logs are currently being recorded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly currentlyLogging: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "currentlyLogging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNetLog#startLogging:member(1)", "docComment": "/**\n * Starts recording network events to `path`.\n *\n * @param path - The file path to write the log to.\n *\n * @param options - Options controlling how events are captured.\n *\n * @returns A promise that resolves when the net log has begun recording.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startLogging(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronStartLoggingOptions", "canonicalReference": "obsidian-typings!ElectronStartLoggingOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "startLogging" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronNetLog#stopLogging:member(1)", "docComment": "/**\n * Stops recording network events. If not called, net logging will automatically end when the app quits.\n *\n * @returns A promise that resolves when the net log has been flushed to disk.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopLogging(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopLogging" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNewWindowWebContentsEvent:interface", "docComment": "/**\n * The event emitted for the deprecated `new-window` event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNewWindowWebContentsEvent extends " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronNewWindowWebContentsEvent.d.ts", "releaseTag": "Public", "name": "ElectronNewWindowWebContentsEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNewWindowWebContentsEvent#newGuest:member", "docComment": "/**\n * The new window instance that must be set when the default window creation is prevented.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newGuest?: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "newGuest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronNotification:class", "docComment": "/**\n * Electron Notification for creating and showing native OS notifications.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronNotification " } ], "fileUrlPath": "src/electron/internals/ElectronNotification.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronNotification", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronNotification:constructor(1)", "docComment": "/**\n * Create a new instance of {@link ElectronNotification}.\n *\n * @param options - Options for constructing the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options?: " }, { "kind": "Reference", "text": "ElectronNotificationConstructorOptions", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#actions:member", "docComment": "/**\n * A `NotificationAction[]` property representing the actions of the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "actions: " }, { "kind": "Reference", "text": "ElectronNotificationAction", "canonicalReference": "obsidian-typings!ElectronNotificationAction:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "actions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#addListener:member(1)", "docComment": "/**\n * Registers an event listener that is invoked when one of the notification's actions is activated.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the index of the activated action.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'action'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", index: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#addListener:member(2)", "docComment": "/**\n * Registers an event listener that is invoked when the notification is clicked by the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#addListener:member(3)", "docComment": "/**\n * Registers an event listener that is invoked when the notification is closed by manual intervention from the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#addListener:member(4)", "docComment": "/**\n * Registers an event listener that is invoked when an error is encountered while creating and showing the native notification. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the error encountered during execution of the `show()` method.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'failed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", error: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#addListener:member(5)", "docComment": "/**\n * Registers an event listener that is invoked when the user clicks the \"Reply\" button on a notification with `hasReply: true`. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the string the user entered into the inline reply field.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'reply'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", reply: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#addListener:member(6)", "docComment": "/**\n * Registers an event listener that is invoked when the notification is shown to the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#body:member", "docComment": "/**\n * A `string` property representing the body of the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "body: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "body", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#close:member(1)", "docComment": "/**\n * Dismisses the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "close" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#closeButtonText:member", "docComment": "/**\n * A `string` property representing the close button text of the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeButtonText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "closeButtonText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#hasReply:member", "docComment": "/**\n * A `boolean` property representing whether the notification has a reply action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasReply: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hasReply", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification.isSupported:member(1)", "docComment": "/**\n * Whether or not desktop notifications are supported on the current system.\n *\n * @returns `true` if desktop notifications are supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static isSupported(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isSupported" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#on:member(1)", "docComment": "/**\n * Registers an event listener that is invoked when one of the notification's actions is activated.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the index of the activated action.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'action'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", index: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#on:member(2)", "docComment": "/**\n * Registers an event listener that is invoked when the notification is clicked by the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#on:member(3)", "docComment": "/**\n * Registers an event listener that is invoked when the notification is closed by manual intervention from the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#on:member(4)", "docComment": "/**\n * Registers an event listener that is invoked when an error is encountered while creating and showing the native notification. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the error encountered during execution of the `show()` method.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'failed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", error: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#on:member(5)", "docComment": "/**\n * Registers an event listener that is invoked when the user clicks the \"Reply\" button on a notification with `hasReply: true`. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the string the user entered into the inline reply field.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'reply'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", reply: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#on:member(6)", "docComment": "/**\n * Registers an event listener that is invoked when the notification is shown to the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#once:member(1)", "docComment": "/**\n * Registers a one-time event listener that is invoked when one of the notification's actions is activated.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the index of the activated action.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'action'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", index: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#once:member(2)", "docComment": "/**\n * Registers a one-time event listener that is invoked when the notification is clicked by the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#once:member(3)", "docComment": "/**\n * Registers a one-time event listener that is invoked when the notification is closed by manual intervention from the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#once:member(4)", "docComment": "/**\n * Registers a one-time event listener that is invoked when an error is encountered while creating and showing the native notification. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the error encountered during execution of the `show()` method.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'failed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", error: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#once:member(5)", "docComment": "/**\n * Registers a one-time event listener that is invoked when the user clicks the \"Reply\" button on a notification with `hasReply: true`. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the string the user entered into the inline reply field.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'reply'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", reply: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#once:member(6)", "docComment": "/**\n * Registers a one-time event listener that is invoked when the notification is shown to the user.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#removeListener:member(1)", "docComment": "/**\n * Removes the event listener for one of the notification's actions being activated.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'action'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", index: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#removeListener:member(2)", "docComment": "/**\n * Removes the event listener for the notification being clicked.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#removeListener:member(3)", "docComment": "/**\n * Removes the event listener for the notification being closed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'close'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#removeListener:member(4)", "docComment": "/**\n * Removes the event listener for the notification failing to show.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'failed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", error: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#removeListener:member(5)", "docComment": "/**\n * Removes the event listener for the notification's inline reply.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'reply'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", reply: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#removeListener:member(6)", "docComment": "/**\n * Removes the event listener for the notification being shown.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This notification instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#replyPlaceholder:member", "docComment": "/**\n * A `string` property representing the reply placeholder of the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replyPlaceholder: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "replyPlaceholder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronNotification#show:member(1)", "docComment": "/**\n * Immediately shows the notification to the user, please note this means unlike the HTML5 Notification implementation, instantiating a `new Notification` does not immediately show it to the user, you need to call this method before the OS will display it.\n *\n * If the notification has been shown before, this method will dismiss the previously shown notification and create a new one with identical properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "show(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "show" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#silent:member", "docComment": "/**\n * A `boolean` property representing whether the notification is silent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "silent: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "silent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#sound:member", "docComment": "/**\n * A `string` property representing the sound of the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sound: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sound", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#subtitle:member", "docComment": "/**\n * A `string` property representing the subtitle of the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subtitle: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subtitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#timeoutType:member", "docComment": "/**\n * A `string` property representing the type of timeout duration for the notification. Can be `default` or `never`.\n *\n * If `timeoutType` is set to `never`, the notification never expires. It stays open until closed by the calling API or the user. `linux` and `win32` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timeoutType: " }, { "kind": "Content", "text": "'default' | 'never'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timeoutType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#title:member", "docComment": "/**\n * A `string` property representing the title of the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#toastXml:member", "docComment": "/**\n * A `string` property representing the custom Toast XML of the notification. `win32` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toastXml: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toastXml", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronNotification#urgency:member", "docComment": "/**\n * A `string` property representing the urgency level of the notification. Can be `normal`, `critical`, or `low`.\n *\n * Default is `low`. `linux` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "urgency: " }, { "kind": "Content", "text": "'critical' | 'low' | 'normal'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "urgency", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNotificationAction:interface", "docComment": "/**\n * An action button shown on a native notification.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNotificationAction " } ], "fileUrlPath": "src/electron/internals/ElectronNotificationAction.d.ts", "releaseTag": "Public", "name": "ElectronNotificationAction", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationAction#text:member", "docComment": "/**\n * The label for the given action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationAction#type:member", "docComment": "/**\n * The type of action, can be `button`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'button'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions:interface", "docComment": "/**\n * Options for constructing an {@link ElectronNotification}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNotificationConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronNotificationConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronNotificationConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#actions:member", "docComment": "/**\n * Actions to add to the notification. Please read the available actions and limitations in the {@link ElectronNotificationAction} documentation. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "actions?: " }, { "kind": "Reference", "text": "ElectronNotificationAction", "canonicalReference": "obsidian-typings!ElectronNotificationAction:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "actions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#body:member", "docComment": "/**\n * The body text of the notification, which will be displayed below the title or subtitle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "body?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "body", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#closeButtonText:member", "docComment": "/**\n * A custom title for the close button of an alert. An empty string will cause the default localized text to be used. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeButtonText?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "closeButtonText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#hasReply:member", "docComment": "/**\n * Whether or not to add an inline reply option to the notification. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasReply?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hasReply", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#icon:member", "docComment": "/**\n * An icon to use in the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#replyPlaceholder:member", "docComment": "/**\n * The placeholder to write in the inline reply input field. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replyPlaceholder?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "replyPlaceholder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#silent:member", "docComment": "/**\n * Whether or not to emit an OS notification noise when showing the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "silent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "silent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#sound:member", "docComment": "/**\n * The name of the sound file to play when the notification is shown. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sound?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sound", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#subtitle:member", "docComment": "/**\n * A subtitle for the notification, which will be displayed below the title. `darwin` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subtitle?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "subtitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#timeoutType:member", "docComment": "/**\n * The timeout duration of the notification. Can be `default` or `never`. `linux` and `win32` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timeoutType?: " }, { "kind": "Content", "text": "'default' | 'never'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "timeoutType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#title:member", "docComment": "/**\n * A title for the notification, which will be shown at the top of the notification window when it is shown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#toastXml:member", "docComment": "/**\n * A custom description of the notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification. `win32` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toastXml?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toastXml", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationConstructorOptions#urgency:member", "docComment": "/**\n * The urgency level of the notification. Can be `normal`, `critical`, or `low`. `linux` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "urgency?: " }, { "kind": "Content", "text": "'critical' | 'low' | 'normal'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "urgency", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronNotificationResponse:interface", "docComment": "/**\n * User's response to a native notification.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronNotificationResponse " } ], "fileUrlPath": "src/electron/internals/ElectronNotificationResponse.d.ts", "releaseTag": "Public", "name": "ElectronNotificationResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationResponse#actionIdentifier:member", "docComment": "/**\n * The identifier string of the action that the user selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "actionIdentifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "actionIdentifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationResponse#date:member", "docComment": "/**\n * The delivery date of the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "date: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "date", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationResponse#identifier:member", "docComment": "/**\n * The unique identifier for this notification request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "identifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "identifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationResponse#userInfo:member", "docComment": "/**\n * A dictionary of custom information associated with the notification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userInfo: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "userInfo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronNotificationResponse#userText:member", "docComment": "/**\n * The text entered or chosen by the user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userText?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "userText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails:interface", "docComment": "/**\n * Details passed to an `onBeforeRedirect` web-request listener.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOnBeforeRedirectListenerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronOnBeforeRedirectListenerDetails.d.ts", "releaseTag": "Public", "name": "ElectronOnBeforeRedirectListenerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#frame:member", "docComment": "/**\n * The frame that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#fromCache:member", "docComment": "/**\n * Whether the response was fetched from cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromCache: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fromCache", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#id:member", "docComment": "/**\n * The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#ip:member", "docComment": "/**\n * The server IP address that the request was actually sent to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ip?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ip", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#redirectURL:member", "docComment": "/**\n * The URL the request is redirected to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redirectURL: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "redirectURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#resourceType:member", "docComment": "/**\n * The resource type of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceType: " }, { "kind": "Content", "text": "'cspReport' | 'font' | 'image' | 'mainFrame' | 'media' | 'object' | 'other' | 'ping' | 'script' | 'stylesheet' | 'subFrame' | 'webSocket' | 'xhr'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#responseHeaders:member", "docComment": "/**\n * The response headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "responseHeaders?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#statusCode:member", "docComment": "/**\n * The HTTP status code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#statusLine:member", "docComment": "/**\n * The HTTP status line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusLine: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusLine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#timestamp:member", "docComment": "/**\n * The time the event occurred, in milliseconds since the epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#webContents:member", "docComment": "/**\n * The web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents?: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails#webContentsId:member", "docComment": "/**\n * The id of the web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContentsId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContentsId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails:interface", "docComment": "/**\n * Details passed to an `onBeforeRequest` web-request listener.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOnBeforeRequestListenerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronOnBeforeRequestListenerDetails.d.ts", "releaseTag": "Public", "name": "ElectronOnBeforeRequestListenerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#frame:member", "docComment": "/**\n * The frame that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#id:member", "docComment": "/**\n * The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#resourceType:member", "docComment": "/**\n * The resource type of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceType: " }, { "kind": "Content", "text": "'cspReport' | 'font' | 'image' | 'mainFrame' | 'media' | 'object' | 'other' | 'ping' | 'script' | 'stylesheet' | 'subFrame' | 'webSocket' | 'xhr'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#timestamp:member", "docComment": "/**\n * The time the event occurred, in milliseconds since the epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#uploadData:member", "docComment": "/**\n * The upload data for the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uploadData: " }, { "kind": "Reference", "text": "ElectronUploadData", "canonicalReference": "obsidian-typings!ElectronUploadData:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "uploadData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#webContents:member", "docComment": "/**\n * The web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents?: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails#webContentsId:member", "docComment": "/**\n * The id of the web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContentsId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContentsId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails:interface", "docComment": "/**\n * Details passed to an `onBeforeSendHeaders` web-request listener.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOnBeforeSendHeadersListenerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronOnBeforeSendHeadersListenerDetails.d.ts", "releaseTag": "Public", "name": "ElectronOnBeforeSendHeadersListenerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#frame:member", "docComment": "/**\n * The frame that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#id:member", "docComment": "/**\n * The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#requestHeaders:member", "docComment": "/**\n * The request headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestHeaders: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#resourceType:member", "docComment": "/**\n * The resource type of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceType: " }, { "kind": "Content", "text": "'cspReport' | 'font' | 'image' | 'mainFrame' | 'media' | 'object' | 'other' | 'ping' | 'script' | 'stylesheet' | 'subFrame' | 'webSocket' | 'xhr'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#timestamp:member", "docComment": "/**\n * The time the event occurred, in milliseconds since the epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#uploadData:member", "docComment": "/**\n * The upload data for the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uploadData?: " }, { "kind": "Reference", "text": "ElectronUploadData", "canonicalReference": "obsidian-typings!ElectronUploadData:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "uploadData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#webContents:member", "docComment": "/**\n * The web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents?: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails#webContentsId:member", "docComment": "/**\n * The id of the web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContentsId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContentsId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails:interface", "docComment": "/**\n * Details passed to an `onCompleted` web-request listener.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOnCompletedListenerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronOnCompletedListenerDetails.d.ts", "releaseTag": "Public", "name": "ElectronOnCompletedListenerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#error:member", "docComment": "/**\n * The error description, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "error: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "error", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#frame:member", "docComment": "/**\n * The frame that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#fromCache:member", "docComment": "/**\n * Whether the response was fetched from cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromCache: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fromCache", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#id:member", "docComment": "/**\n * The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#resourceType:member", "docComment": "/**\n * The resource type of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceType: " }, { "kind": "Content", "text": "'cspReport' | 'font' | 'image' | 'mainFrame' | 'media' | 'object' | 'other' | 'ping' | 'script' | 'stylesheet' | 'subFrame' | 'webSocket' | 'xhr'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#responseHeaders:member", "docComment": "/**\n * The response headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "responseHeaders?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#statusCode:member", "docComment": "/**\n * The HTTP status code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#statusLine:member", "docComment": "/**\n * The HTTP status line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusLine: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusLine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#timestamp:member", "docComment": "/**\n * The time the event occurred, in milliseconds since the epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#webContents:member", "docComment": "/**\n * The web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents?: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails#webContentsId:member", "docComment": "/**\n * The id of the web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContentsId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContentsId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails:interface", "docComment": "/**\n * Details passed to an `onErrorOccurred` web-request listener.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOnErrorOccurredListenerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronOnErrorOccurredListenerDetails.d.ts", "releaseTag": "Public", "name": "ElectronOnErrorOccurredListenerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#error:member", "docComment": "/**\n * The error description.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "error: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "error", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#frame:member", "docComment": "/**\n * The frame that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#fromCache:member", "docComment": "/**\n * Whether the response was fetched from cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromCache: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fromCache", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#id:member", "docComment": "/**\n * The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#resourceType:member", "docComment": "/**\n * The resource type of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceType: " }, { "kind": "Content", "text": "'cspReport' | 'font' | 'image' | 'mainFrame' | 'media' | 'object' | 'other' | 'ping' | 'script' | 'stylesheet' | 'subFrame' | 'webSocket' | 'xhr'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#timestamp:member", "docComment": "/**\n * The time the event occurred, in milliseconds since the epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#webContents:member", "docComment": "/**\n * The web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents?: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails#webContentsId:member", "docComment": "/**\n * The id of the web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContentsId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContentsId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails:interface", "docComment": "/**\n * Details passed to an `onHeadersReceived` web-request listener.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOnHeadersReceivedListenerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronOnHeadersReceivedListenerDetails.d.ts", "releaseTag": "Public", "name": "ElectronOnHeadersReceivedListenerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#frame:member", "docComment": "/**\n * The frame that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#id:member", "docComment": "/**\n * The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#resourceType:member", "docComment": "/**\n * The resource type of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceType: " }, { "kind": "Content", "text": "'cspReport' | 'font' | 'image' | 'mainFrame' | 'media' | 'object' | 'other' | 'ping' | 'script' | 'stylesheet' | 'subFrame' | 'webSocket' | 'xhr'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#responseHeaders:member", "docComment": "/**\n * The response headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "responseHeaders?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#statusCode:member", "docComment": "/**\n * The HTTP status code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#statusLine:member", "docComment": "/**\n * The HTTP status line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusLine: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusLine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#timestamp:member", "docComment": "/**\n * The time the event occurred, in milliseconds since the epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#webContents:member", "docComment": "/**\n * The web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents?: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails#webContentsId:member", "docComment": "/**\n * The id of the web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContentsId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContentsId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails:interface", "docComment": "/**\n * Details passed to an `onResponseStarted` web-request listener.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOnResponseStartedListenerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronOnResponseStartedListenerDetails.d.ts", "releaseTag": "Public", "name": "ElectronOnResponseStartedListenerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#frame:member", "docComment": "/**\n * The frame that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#fromCache:member", "docComment": "/**\n * Whether the response was fetched from disk cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromCache: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fromCache", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#id:member", "docComment": "/**\n * The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#resourceType:member", "docComment": "/**\n * The resource type of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceType: " }, { "kind": "Content", "text": "'cspReport' | 'font' | 'image' | 'mainFrame' | 'media' | 'object' | 'other' | 'ping' | 'script' | 'stylesheet' | 'subFrame' | 'webSocket' | 'xhr'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#responseHeaders:member", "docComment": "/**\n * The response headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "responseHeaders?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#statusCode:member", "docComment": "/**\n * The HTTP status code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#statusLine:member", "docComment": "/**\n * The HTTP status line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusLine: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusLine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#timestamp:member", "docComment": "/**\n * The time the event occurred, in milliseconds since the epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#webContents:member", "docComment": "/**\n * The web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents?: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails#webContentsId:member", "docComment": "/**\n * The id of the web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContentsId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContentsId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails:interface", "docComment": "/**\n * Details passed to an `onSendHeaders` web-request listener.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOnSendHeadersListenerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronOnSendHeadersListenerDetails.d.ts", "releaseTag": "Public", "name": "ElectronOnSendHeadersListenerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#frame:member", "docComment": "/**\n * The frame that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame?: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#id:member", "docComment": "/**\n * The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#requestHeaders:member", "docComment": "/**\n * The request headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestHeaders: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestHeaders", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#resourceType:member", "docComment": "/**\n * The resource type of the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceType: " }, { "kind": "Content", "text": "'cspReport' | 'font' | 'image' | 'mainFrame' | 'media' | 'object' | 'other' | 'ping' | 'script' | 'stylesheet' | 'subFrame' | 'webSocket' | 'xhr'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#timestamp:member", "docComment": "/**\n * The time the event occurred, in milliseconds since the epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#webContents:member", "docComment": "/**\n * The web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents?: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails#webContentsId:member", "docComment": "/**\n * The id of the web contents that initiated the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContentsId?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webContentsId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions:interface", "docComment": "/**\n * Options for Electron open file dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOpenDialogOptions " } ], "fileUrlPath": "src/electron/internals/ElectronOpenDialogOptions.d.ts", "releaseTag": "Public", "name": "ElectronOpenDialogOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions#buttonLabel:member", "docComment": "/**\n * The label for the confirmation button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttonLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "buttonLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions#defaultPath:member", "docComment": "/**\n * The default path to open the dialog at.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions#filters:member", "docComment": "/**\n * The file filters to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters?: " }, { "kind": "Reference", "text": "ElectronFileFilter", "canonicalReference": "obsidian-typings!ElectronFileFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions#message:member", "docComment": "/**\n * The message to display above the dialog on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions#properties:member", "docComment": "/**\n * The dialog behavior properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<\n | 'createDirectory'\n | 'dontAddToRecent'\n | 'multiSelections'\n | 'noResolveAliases'\n | 'openDirectory'\n | 'openFile'\n | 'promptToCreate'\n | 'showHiddenFiles'\n | 'treatPackageAsDirectory'\n >" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions#securityScopedBookmarks:member", "docComment": "/**\n * Whether to create security scoped bookmarks when packaged for the Mac App Store (macOS, mas only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "securityScopedBookmarks?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "securityScopedBookmarks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogOptions#title:member", "docComment": "/**\n * The dialog title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOpenDialogReturnValue:interface", "docComment": "/**\n * Return value from an Electron open file dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOpenDialogReturnValue " } ], "fileUrlPath": "src/electron/internals/ElectronOpenDialogReturnValue.d.ts", "releaseTag": "Public", "name": "ElectronOpenDialogReturnValue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogReturnValue#bookmarks:member", "docComment": "/**\n * An array matching the `filePaths` array of base64 encoded strings which contains security scoped bookmark data (macOS, mas only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bookmarks?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "bookmarks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogReturnValue#canceled:member", "docComment": "/**\n * Whether the dialog was canceled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canceled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canceled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogReturnValue#filePaths:member", "docComment": "/**\n * The file paths chosen by the user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filePaths: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filePaths", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions:interface", "docComment": "/**\n * Options for Electron synchronous open file dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronOpenDialogSyncOptions " } ], "fileUrlPath": "src/electron/internals/ElectronOpenDialogSyncOptions.d.ts", "releaseTag": "Public", "name": "ElectronOpenDialogSyncOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions#buttonLabel:member", "docComment": "/**\n * The label for the confirmation button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttonLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "buttonLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions#defaultPath:member", "docComment": "/**\n * The default path to open the dialog at.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions#filters:member", "docComment": "/**\n * The file filters to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters?: " }, { "kind": "Reference", "text": "ElectronFileFilter", "canonicalReference": "obsidian-typings!ElectronFileFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions#message:member", "docComment": "/**\n * The message to display above the dialog on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions#properties:member", "docComment": "/**\n * The dialog behavior properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<\n | 'createDirectory'\n | 'dontAddToRecent'\n | 'multiSelections'\n | 'noResolveAliases'\n | 'openDirectory'\n | 'openFile'\n | 'promptToCreate'\n | 'showHiddenFiles'\n | 'treatPackageAsDirectory'\n >" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions#securityScopedBookmarks:member", "docComment": "/**\n * Whether to create security scoped bookmarks when packaged for the Mac App Store (macOS, mas only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "securityScopedBookmarks?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "securityScopedBookmarks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronOpenDialogSyncOptions#title:member", "docComment": "/**\n * The dialog title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPageRanges:interface", "docComment": "/**\n * A range of pages to print.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPageRanges " } ], "fileUrlPath": "src/electron/internals/ElectronPageRanges.d.ts", "releaseTag": "Public", "name": "ElectronPageRanges", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPageRanges#from:member", "docComment": "/**\n * Index of the first page to print (`0`-based).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPageRanges#to:member", "docComment": "/**\n * Index of the last page to print (inclusive) (`0`-based).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronParameters:interface", "docComment": "/**\n * Parameters for device emulation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronParameters " } ], "fileUrlPath": "src/electron/internals/ElectronParameters.d.ts", "releaseTag": "Public", "name": "ElectronParameters", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronParameters#deviceScaleFactor:member", "docComment": "/**\n * The device scale factor. If zero, defaults to the original device scale factor.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceScaleFactor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deviceScaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronParameters#scale:member", "docComment": "/**\n * Scale of the emulated view inside the available space (not in fit-to-view mode).\n *\n * @default\n *\n * `1`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronParameters#screenPosition:member", "docComment": "/**\n * The screen type to emulate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "screenPosition: " }, { "kind": "Content", "text": "'desktop' | 'mobile'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "screenPosition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronParameters#screenSize:member", "docComment": "/**\n * The emulated screen size, used when `screenPosition` is `mobile`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "screenSize: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "screenSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronParameters#viewPosition:member", "docComment": "/**\n * The position of the view on the screen, used when `screenPosition` is `mobile`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewPosition: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewPosition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronParameters#viewSize:member", "docComment": "/**\n * The emulated view size. An empty value means no override.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewSize: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPayment:interface", "docComment": "/**\n * A payment in the Mac App Store payment queue.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPayment " } ], "fileUrlPath": "src/electron/internals/ElectronPayment.d.ts", "releaseTag": "Public", "name": "ElectronPayment", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPayment#applicationUsername:member", "docComment": "/**\n * An opaque identifier for the user's account on your system.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applicationUsername: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "applicationUsername", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPayment#paymentDiscount:member", "docComment": "/**\n * The details of the discount offer to apply to the payment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paymentDiscount?: " }, { "kind": "Reference", "text": "ElectronPaymentDiscount", "canonicalReference": "obsidian-typings!ElectronPaymentDiscount:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "paymentDiscount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPayment#productIdentifier:member", "docComment": "/**\n * The identifier of the purchased product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "productIdentifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "productIdentifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPayment#quantity:member", "docComment": "/**\n * The quantity purchased.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "quantity: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "quantity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPaymentDiscount:interface", "docComment": "/**\n * Details of a discount offer to apply to a payment.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPaymentDiscount " } ], "fileUrlPath": "src/electron/internals/ElectronPaymentDiscount.d.ts", "releaseTag": "Public", "name": "ElectronPaymentDiscount", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPaymentDiscount#identifier:member", "docComment": "/**\n * A string used to uniquely identify a discount offer for a product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "identifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "identifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPaymentDiscount#keyIdentifier:member", "docComment": "/**\n * A string that identifies the key used to generate the signature.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyIdentifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyIdentifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPaymentDiscount#nonce:member", "docComment": "/**\n * A universally unique ID (UUID) value that you define.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nonce: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nonce", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPaymentDiscount#signature:member", "docComment": "/**\n * A UTF-8 string representing the properties of a specific discount offer, cryptographically signed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "signature: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "signature", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPaymentDiscount#timestamp:member", "docComment": "/**\n * The date and time of the signature's creation in milliseconds, formatted in Unix epoch time.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPermissionCheckHandlerHandlerDetails:interface", "docComment": "/**\n * Details passed to a permission check handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPermissionCheckHandlerHandlerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronPermissionCheckHandlerHandlerDetails.d.ts", "releaseTag": "Public", "name": "ElectronPermissionCheckHandlerHandlerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionCheckHandlerHandlerDetails#embeddingOrigin:member", "docComment": "/**\n * The origin of the frame embedding the frame that made the permission check. Only set for cross-origin sub frames.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "embeddingOrigin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "embeddingOrigin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionCheckHandlerHandlerDetails#isMainFrame:member", "docComment": "/**\n * Whether the frame making the request is the main frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMainFrame: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMainFrame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionCheckHandlerHandlerDetails#mediaType:member", "docComment": "/**\n * The type of media access being requested.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mediaType?: " }, { "kind": "Content", "text": "'audio' | 'unknown' | 'video'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mediaType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionCheckHandlerHandlerDetails#requestingUrl:member", "docComment": "/**\n * The last URL the requesting frame loaded. Not provided for cross-origin sub frames.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestingUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "requestingUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionCheckHandlerHandlerDetails#securityOrigin:member", "docComment": "/**\n * The security origin of the `media` check.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "securityOrigin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "securityOrigin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPermissionRequestHandlerHandlerDetails:interface", "docComment": "/**\n * Details passed to a permission request handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPermissionRequestHandlerHandlerDetails " } ], "fileUrlPath": "src/electron/internals/ElectronPermissionRequestHandlerHandlerDetails.d.ts", "releaseTag": "Public", "name": "ElectronPermissionRequestHandlerHandlerDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionRequestHandlerHandlerDetails#externalURL:member", "docComment": "/**\n * The URL of the `openExternal` request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "externalURL?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "externalURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionRequestHandlerHandlerDetails#isMainFrame:member", "docComment": "/**\n * Whether the frame making the request is the main frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMainFrame: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMainFrame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionRequestHandlerHandlerDetails#mediaTypes:member", "docComment": "/**\n * The types of media access being requested.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mediaTypes?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<'audio' | 'video'>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mediaTypes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionRequestHandlerHandlerDetails#requestingUrl:member", "docComment": "/**\n * The last URL the requesting frame loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestingUrl: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestingUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPermissionRequestHandlerHandlerDetails#securityOrigin:member", "docComment": "/**\n * The security origin of the `media` request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "securityOrigin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "securityOrigin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPoint:interface", "docComment": "/**\n * Represents a point with x and y coordinates.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPoint " } ], "fileUrlPath": "src/electron/internals/ElectronPoint.d.ts", "releaseTag": "Public", "name": "ElectronPoint", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPoint#x:member", "docComment": "/**\n * The x coordinate of the point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPoint#y:member", "docComment": "/**\n * The y coordinate of the point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPostBody:interface", "docComment": "/**\n * The post data sent to a new window.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPostBody " } ], "fileUrlPath": "src/electron/internals/ElectronPostBody.d.ts", "releaseTag": "Public", "name": "ElectronPostBody", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPostBody#boundary:member", "docComment": "/**\n * The boundary used to separate multiple parts of the message. Only valid when `contentType` is `multipart/form-data`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "boundary?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "boundary", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPostBody#contentType:member", "docComment": "/**\n * The `content-type` header used for the data. One of `application/x-www-form-urlencoded` or `multipart/form-data`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPostBody#data:member", "docComment": "/**\n * The post data to be sent to the new window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ElectronUploadFile", "canonicalReference": "obsidian-typings!ElectronUploadFile:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronUploadRawData", "canonicalReference": "obsidian-typings!ElectronUploadRawData:interface" }, { "kind": "Content", "text": ")[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPowerMonitor:interface", "docComment": "/**\n * Electron `powerMonitor` module for monitoring power state changes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPowerMonitor extends " }, { "kind": "Reference", "text": "NodeJS.EventEmitter", "canonicalReference": "!\"\\\"node:events\\\"\".__global.NodeJS.EventEmitter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronPowerMonitor.d.ts", "releaseTag": "Public", "name": "ElectronPowerMonitor", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(1)", "docComment": "/**\n * Emitted when the system is about to lock the screen.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'lock-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(2)", "docComment": "/**\n * Emitted when the system changes to AC power.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'on-ac'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(3)", "docComment": "/**\n * Emitted when the system changes to battery power.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'on-battery'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(4)", "docComment": "/**\n * Emitted when the system is resuming.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'resume'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(5)", "docComment": "/**\n * Emitted when the system is about to reboot or shut down. If the event handler invokes `event.preventDefault()`, Electron will attempt to delay system shutdown in order for the app to exit cleanly.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `linux,darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'shutdown'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(6)", "docComment": "/**\n * Emitted when the system is suspending.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'suspend'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(7)", "docComment": "/**\n * Emitted as soon as the system's screen is unlocked.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'unlock-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(8)", "docComment": "/**\n * Emitted when a login session is activated.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'user-did-become-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#addListener:member(9)", "docComment": "/**\n * Emitted when a login session is deactivated.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'user-did-resign-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#getSystemIdleState:member(1)", "docComment": "/**\n * Calculate the system idle state. `idleThreshold` is the amount of time (in seconds) before considered idle. `locked` is available on supported systems only.\n *\n * @param idleThreshold - The amount of time (in seconds) before the system is considered idle.\n *\n * @returns The system's current state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSystemIdleState(idleThreshold: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "'active' | 'idle' | 'locked' | 'unknown'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "idleThreshold", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSystemIdleState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#getSystemIdleTime:member(1)", "docComment": "/**\n * Calculate system idle time in seconds.\n *\n * @returns Idle time in seconds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSystemIdleTime(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSystemIdleTime" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#isOnBatteryPower:member(1)", "docComment": "/**\n * Whether the system is on battery power.\n *\n * To monitor for changes in this property, use the `on-battery` and `on-ac` events.\n *\n * @returns `true` if the system is on battery power.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isOnBatteryPower(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isOnBatteryPower" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(1)", "docComment": "/**\n * Emitted when the system is about to lock the screen.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'lock-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(2)", "docComment": "/**\n * Emitted when the system changes to AC power.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'on-ac'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(3)", "docComment": "/**\n * Emitted when the system changes to battery power.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'on-battery'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(4)", "docComment": "/**\n * Emitted when the system is resuming.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'resume'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(5)", "docComment": "/**\n * Emitted when the system is about to reboot or shut down. If the event handler invokes `event.preventDefault()`, Electron will attempt to delay system shutdown in order for the app to exit cleanly.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `linux,darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'shutdown'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(6)", "docComment": "/**\n * Emitted when the system is suspending.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'suspend'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(7)", "docComment": "/**\n * Emitted as soon as the system's screen is unlocked.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'unlock-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(8)", "docComment": "/**\n * Emitted when a login session is activated.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'user-did-become-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#on:member(9)", "docComment": "/**\n * Emitted when a login session is deactivated.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked when the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'user-did-resign-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#onBatteryPower:member", "docComment": "/**\n * `true` if the system is on battery power.\n *\n * @see\n *\n * `isOnBatteryPower`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onBatteryPower: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onBatteryPower", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(1)", "docComment": "/**\n * Adds a one-time listener for the `lock-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'lock-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(2)", "docComment": "/**\n * Adds a one-time listener for the `on-ac` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'on-ac'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(3)", "docComment": "/**\n * Adds a one-time listener for the `on-battery` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'on-battery'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(4)", "docComment": "/**\n * Adds a one-time listener for the `resume` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'resume'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(5)", "docComment": "/**\n * Adds a one-time listener for the `shutdown` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `linux,darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'shutdown'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(6)", "docComment": "/**\n * Adds a one-time listener for the `suspend` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'suspend'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(7)", "docComment": "/**\n * Adds a one-time listener for the `unlock-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'unlock-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(8)", "docComment": "/**\n * Adds a one-time listener for the `user-did-become-active` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'user-did-become-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#once:member(9)", "docComment": "/**\n * Adds a one-time listener for the `user-did-resign-active` event.\n *\n * @param event - The event name.\n *\n * @param listener - Callback invoked the next time the event is emitted.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'user-did-resign-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(1)", "docComment": "/**\n * Removes the specified `listener` from the `lock-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'lock-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(2)", "docComment": "/**\n * Removes the specified `listener` from the `on-ac` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'on-ac'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(3)", "docComment": "/**\n * Removes the specified `listener` from the `on-battery` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'on-battery'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(4)", "docComment": "/**\n * Removes the specified `listener` from the `resume` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'resume'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(5)", "docComment": "/**\n * Removes the specified `listener` from the `shutdown` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance. Platform: `linux,darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'shutdown'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(6)", "docComment": "/**\n * Removes the specified `listener` from the `suspend` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'suspend'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(7)", "docComment": "/**\n * Removes the specified `listener` from the `unlock-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin,win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'unlock-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(8)", "docComment": "/**\n * Removes the specified `listener` from the `user-did-become-active` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'user-did-become-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerMonitor#removeListener:member(9)", "docComment": "/**\n * Removes the specified `listener` from the `user-did-resign-active` event.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This `PowerMonitor` instance. Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'user-did-resign-active'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPowerSaveBlocker:interface", "docComment": "/**\n * Electron `powerSaveBlocker` module for blocking the system from entering low-power (sleep) mode.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPowerSaveBlocker " } ], "fileUrlPath": "src/electron/internals/ElectronPowerSaveBlocker.d.ts", "releaseTag": "Public", "name": "ElectronPowerSaveBlocker", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerSaveBlocker#isStarted:member(1)", "docComment": "/**\n * Whether the corresponding `powerSaveBlocker` has started.\n *\n * @param id - The power save blocker id returned by `start`.\n *\n * @returns `true` if the power save blocker with the given `id` is currently active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isStarted(id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isStarted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerSaveBlocker#start:member(1)", "docComment": "/**\n * Starts preventing the system from entering lower-power mode. Returns an integer identifying the power save blocker.\n *\n * `prevent-display-sleep` has higher precedence over `prevent-app-suspension`. Only the highest precedence type takes effect. In other words, `prevent-display-sleep` always takes precedence over `prevent-app-suspension`.\n *\n * @param type - The kind of power save blocker to start.\n *\n * @returns The blocker id assigned to this power save blocker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start(type: " }, { "kind": "Content", "text": "'prevent-app-suspension' | 'prevent-display-sleep'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "start" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronPowerSaveBlocker#stop:member(1)", "docComment": "/**\n * Stops the specified power save blocker.\n *\n * @param id - The power save blocker id returned by `start`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stop(id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "stop" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPreconnectOptions:interface", "docComment": "/**\n * Options controlling how sockets are preconnected to an origin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPreconnectOptions " } ], "fileUrlPath": "src/electron/internals/ElectronPreconnectOptions.d.ts", "releaseTag": "Public", "name": "ElectronPreconnectOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPreconnectOptions#numSockets:member", "docComment": "/**\n * Number of sockets to preconnect. Must be between 1 and 6.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "numSockets?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "numSockets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPreconnectOptions#url:member", "docComment": "/**\n * URL for preconnect. Only the origin is relevant for opening the socket.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPrinterInfo:interface", "docComment": "/**\n * Information about a system printer.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPrinterInfo " } ], "fileUrlPath": "src/electron/internals/ElectronPrinterInfo.d.ts", "releaseTag": "Public", "name": "ElectronPrinterInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrinterInfo#description:member", "docComment": "/**\n * A longer description of the printer's type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrinterInfo#displayName:member", "docComment": "/**\n * The name of the printer as shown in Print Preview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "displayName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrinterInfo#isDefault:member", "docComment": "/**\n * Whether the printer is set as the default printer on the OS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDefault: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isDefault", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrinterInfo#name:member", "docComment": "/**\n * The name of the printer as understood by the OS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrinterInfo#options:member", "docComment": "/**\n * An object containing a variable number of platform-specific printer information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "ElectronPrinterInfoOptions", "canonicalReference": "obsidian-typings!ElectronPrinterInfoOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrinterInfo#status:member", "docComment": "/**\n * The current status of the printer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "status: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "status", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPrinterInfoOptions:interface", "docComment": "/**\n * An object containing a variable number of platform-specific printer information entries.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPrinterInfoOptions " } ], "fileUrlPath": "src/electron/internals/ElectronPrinterInfoOptions.d.ts", "releaseTag": "Public", "name": "ElectronPrinterInfoOptions", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!ElectronPrinterInfoOptions:index(1)", "docComment": "/**\n * Platform-specific printer information keyed by option name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions:interface", "docComment": "/**\n * Options for printing a web page to PDF.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPrintToPDFOptions " } ], "fileUrlPath": "src/electron/internals/ElectronPrintToPDFOptions.d.ts", "releaseTag": "Public", "name": "ElectronPrintToPDFOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions#headerFooter:member", "docComment": "/**\n * The header and footer for the PDF.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headerFooter?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "headerFooter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions#landscape:member", "docComment": "/**\n * `true` for landscape, `false` for portrait.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "landscape?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "landscape", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions#marginsType:member", "docComment": "/**\n * Specifies the type of margins to use. Uses `0` for default margin, `1` for no margin, and `2` for minimum margin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "marginsType?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "marginsType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions#pageRanges:member", "docComment": "/**\n * The page range to print. On macOS, only the first range is honored.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageRanges?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, number>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pageRanges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions#pageSize:member", "docComment": "/**\n * The page size of the generated PDF. Can be `A3`, `A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an object containing `height` and `width`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageSize?: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pageSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions#printBackground:member", "docComment": "/**\n * Whether to print CSS backgrounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "printBackground?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "printBackground", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions#printSelectionOnly:member", "docComment": "/**\n * Whether to print the selection only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "printSelectionOnly?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "printSelectionOnly", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions#scaleFactor:member", "docComment": "/**\n * The scale factor of the web page. Can range from `0` to `100`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronPrivileges:interface", "docComment": "/**\n * Privileges granted to a custom scheme registered with a protocol.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronPrivileges " } ], "fileUrlPath": "src/electron/internals/ElectronPrivileges.d.ts", "releaseTag": "Public", "name": "ElectronPrivileges", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrivileges#allowServiceWorkers:member", "docComment": "/**\n * Whether to allow registering ServiceWorkers for this scheme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowServiceWorkers?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "allowServiceWorkers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrivileges#bypassCSP:member", "docComment": "/**\n * Whether to bypass the Content Security Policy for resources served by this scheme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bypassCSP?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "bypassCSP", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrivileges#corsEnabled:member", "docComment": "/**\n * Whether to enable CORS for this scheme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "corsEnabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "corsEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrivileges#secure:member", "docComment": "/**\n * Whether to treat the scheme as secure.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "secure?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "secure", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrivileges#standard:member", "docComment": "/**\n * Whether to treat the scheme as a standard scheme (generic URI syntax).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "standard?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "standard", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrivileges#stream:member", "docComment": "/**\n * Whether the scheme should be treated as streaming for `<video>` and `<audio>` elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stream?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "stream", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronPrivileges#supportFetchAPI:member", "docComment": "/**\n * Whether to support the fetch API for this scheme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "supportFetchAPI?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "supportFetchAPI", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProcessMetric:interface", "docComment": "/**\n * Memory and CPU usage statistics for a process associated with the app.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProcessMetric " } ], "fileUrlPath": "src/electron/internals/ElectronProcessMetric.d.ts", "releaseTag": "Public", "name": "ElectronProcessMetric", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#cpu:member", "docComment": "/**\n * CPU usage of the process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cpu: " }, { "kind": "Reference", "text": "ElectronCPUUsage", "canonicalReference": "obsidian-typings!ElectronCPUUsage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cpu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#creationTime:member", "docComment": "/**\n * Creation time for this process, represented as number of milliseconds since epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "creationTime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "creationTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#integrityLevel:member", "docComment": "/**\n * The security integrity level of the process. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "integrityLevel?: " }, { "kind": "Content", "text": "'high' | 'low' | 'medium' | 'unknown' | 'untrusted'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "integrityLevel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#memory:member", "docComment": "/**\n * Memory information for the process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "memory: " }, { "kind": "Reference", "text": "ElectronMemoryInfo", "canonicalReference": "obsidian-typings!ElectronMemoryInfo:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "memory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#name:member", "docComment": "/**\n * The name of the process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#pid:member", "docComment": "/**\n * Process id of the process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pid: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pid", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#sandboxed:member", "docComment": "/**\n * Whether the process is sandboxed on OS level. macOS and Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sandboxed?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sandboxed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#serviceName:member", "docComment": "/**\n * The non-localized name of the process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serviceName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "serviceName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProcessMetric#type:member", "docComment": "/**\n * Process type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'Browser' | 'GPU' | 'Pepper Plugin' | 'Pepper Plugin Broker' | 'Sandbox helper' | 'Tab' | 'Unknown' | 'Utility' | 'Zygote'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProduct:interface", "docComment": "/**\n * A product available for purchase from the Mac App Store.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProduct " } ], "fileUrlPath": "src/electron/internals/ElectronProduct.d.ts", "releaseTag": "Public", "name": "ElectronProduct", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#contentLengths:member", "docComment": "/**\n * The total size of the content, in bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentLengths: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentLengths", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#contentVersion:member", "docComment": "/**\n * A string that identifies the version of the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentVersion: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentVersion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#currencyCode:member", "docComment": "/**\n * 3 character code presenting a product's currency based on the ISO 4217 standard.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "currencyCode: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "currencyCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#discounts:member", "docComment": "/**\n * An array of discount offers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "discounts: " }, { "kind": "Reference", "text": "ElectronProductDiscount", "canonicalReference": "obsidian-typings!ElectronProductDiscount:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "discounts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#downloadContentLengths:member", "docComment": "/**\n * The total size of the content, in bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadContentLengths: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "downloadContentLengths", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#downloadContentVersion:member", "docComment": "/**\n * A string that identifies the version of the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadContentVersion: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "downloadContentVersion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#formattedPrice:member", "docComment": "/**\n * The locale formatted price of the product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "formattedPrice: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "formattedPrice", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#introductoryPrice:member", "docComment": "/**\n * The object containing introductory price information for the product, available for the product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "introductoryPrice?: " }, { "kind": "Reference", "text": "ElectronProductDiscount", "canonicalReference": "obsidian-typings!ElectronProductDiscount:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "introductoryPrice", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#isDownloadable:member", "docComment": "/**\n * A boolean value that indicates whether the App Store has downloadable content for this product. `true` if at least one file has been associated with the product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDownloadable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isDownloadable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#localizedDescription:member", "docComment": "/**\n * A description of the product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "localizedDescription: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "localizedDescription", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#localizedTitle:member", "docComment": "/**\n * The name of the product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "localizedTitle: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "localizedTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#price:member", "docComment": "/**\n * The cost of the product in the local currency.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "price: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "price", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#productIdentifier:member", "docComment": "/**\n * The string that identifies the product to the Apple App Store.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "productIdentifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "productIdentifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#subscriptionGroupIdentifier:member", "docComment": "/**\n * The identifier of the subscription group to which the subscription belongs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subscriptionGroupIdentifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subscriptionGroupIdentifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProduct#subscriptionPeriod:member", "docComment": "/**\n * The period details for products that are subscriptions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subscriptionPeriod?: " }, { "kind": "Reference", "text": "ElectronProductSubscriptionPeriod", "canonicalReference": "obsidian-typings!ElectronProductSubscriptionPeriod:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "subscriptionPeriod", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProductDiscount:interface", "docComment": "/**\n * A discount offer for a product in the Mac App Store.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProductDiscount " } ], "fileUrlPath": "src/electron/internals/ElectronProductDiscount.d.ts", "releaseTag": "Public", "name": "ElectronProductDiscount", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductDiscount#identifier:member", "docComment": "/**\n * A string used to uniquely identify a discount offer for a product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "identifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "identifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductDiscount#numberOfPeriods:member", "docComment": "/**\n * An integer that indicates the number of periods the product discount is available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "numberOfPeriods: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numberOfPeriods", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductDiscount#paymentMode:member", "docComment": "/**\n * The payment mode for this product discount. Can be `freeTrial`, `payAsYouGo` or `payUpFront`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paymentMode: " }, { "kind": "Content", "text": "'freeTrial' | 'payAsYouGo' | 'payUpFront'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "paymentMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductDiscount#price:member", "docComment": "/**\n * The discount price of the product in the local currency.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "price: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "price", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductDiscount#priceLocale:member", "docComment": "/**\n * The locale used to format the discount price of the product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "priceLocale: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "priceLocale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductDiscount#subscriptionPeriod:member", "docComment": "/**\n * An object that defines the period for the product discount.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subscriptionPeriod?: " }, { "kind": "Reference", "text": "ElectronProductSubscriptionPeriod", "canonicalReference": "obsidian-typings!ElectronProductSubscriptionPeriod:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "subscriptionPeriod", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductDiscount#type:member", "docComment": "/**\n * The type of discount offer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProductSubscriptionPeriod:interface", "docComment": "/**\n * The period details for products that are subscriptions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProductSubscriptionPeriod " } ], "fileUrlPath": "src/electron/internals/ElectronProductSubscriptionPeriod.d.ts", "releaseTag": "Public", "name": "ElectronProductSubscriptionPeriod", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductSubscriptionPeriod#numberOfUnits:member", "docComment": "/**\n * The number of units per subscription period.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "numberOfUnits: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numberOfUnits", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProductSubscriptionPeriod#unit:member", "docComment": "/**\n * The increment of time that a subscription period is specified in. Can be `day`, `month`, `week` or `year`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unit: " }, { "kind": "Content", "text": "'day' | 'month' | 'week' | 'year'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "unit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProgressBarOptions:interface", "docComment": "/**\n * Options for {@link ElectronBrowserWindow.setProgressBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProgressBarOptions " } ], "fileUrlPath": "src/electron/internals/ElectronProgressBarOptions.d.ts", "releaseTag": "Public", "name": "ElectronProgressBarOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProgressBarOptions#mode:member", "docComment": "/**\n * Mode for the progress bar (Windows only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode: " }, { "kind": "Content", "text": "'error' | 'indeterminate' | 'none' | 'normal' | 'paused'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProtocol:interface", "docComment": "/**\n * Registers and intercepts custom protocol schemes for a session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProtocol " } ], "fileUrlPath": "src/electron/internals/ElectronProtocol.d.ts", "releaseTag": "Public", "name": "ElectronProtocol", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#interceptBufferProtocol:member(1)", "docComment": "/**\n * Intercepts `scheme` and uses `handler` as the new handler which sends a `Buffer` as a response.\n *\n * @param scheme - The scheme to intercept.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully intercepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interceptBufferProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "interceptBufferProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#interceptFileProtocol:member(1)", "docComment": "/**\n * Intercepts `scheme` and uses `handler` as the new handler which sends a file as a response.\n *\n * @param scheme - The scheme to intercept.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully intercepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interceptFileProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": " | string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "interceptFileProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#interceptHttpProtocol:member(1)", "docComment": "/**\n * Intercepts `scheme` and uses `handler` as the new handler which sends a new HTTP request as a response.\n *\n * @param scheme - The scheme to intercept.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully intercepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interceptHttpProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "interceptHttpProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#interceptStreamProtocol:member(1)", "docComment": "/**\n * Same as `registerStreamProtocol`, except that it replaces an existing protocol handler.\n *\n * @param scheme - The scheme to intercept.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully intercepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interceptStreamProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "!\"\\\"node:stream\\\"\".__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "interceptStreamProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#interceptStringProtocol:member(1)", "docComment": "/**\n * Intercepts `scheme` and uses `handler` as the new handler which sends a `string` as a response.\n *\n * @param scheme - The scheme to intercept.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully intercepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interceptStringProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": " | string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "interceptStringProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#isProtocolIntercepted:member(1)", "docComment": "/**\n * Returns whether `scheme` is already intercepted.\n *\n * @param scheme - The scheme to check.\n *\n * @returns Whether the scheme is intercepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isProtocolIntercepted(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isProtocolIntercepted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#isProtocolRegistered:member(1)", "docComment": "/**\n * Returns whether `scheme` is already registered.\n *\n * @param scheme - The scheme to check.\n *\n * @returns Whether the scheme is registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isProtocolRegistered(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isProtocolRegistered" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#registerBufferProtocol:member(1)", "docComment": "/**\n * Registers a protocol of `scheme` that will send a `Buffer` as a response.\n *\n * @param scheme - The scheme to register.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerBufferProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "registerBufferProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#registerFileProtocol:member(1)", "docComment": "/**\n * Registers a protocol of `scheme` that will send a file as the response.\n *\n * @param scheme - The scheme to register.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerFileProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": " | string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "registerFileProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#registerHttpProtocol:member(1)", "docComment": "/**\n * Registers a protocol of `scheme` that will send an HTTP request as a response.\n *\n * @param scheme - The scheme to register.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerHttpProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "registerHttpProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#registerSchemesAsPrivileged:member(1)", "docComment": "/**\n * Registers the given schemes as privileged. Can only be called before the `ready` event and only once.\n *\n * @param customSchemes - The schemes to register with their privileges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerSchemesAsPrivileged(customSchemes: " }, { "kind": "Reference", "text": "ElectronCustomScheme", "canonicalReference": "obsidian-typings!ElectronCustomScheme:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "customSchemes", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "registerSchemesAsPrivileged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#registerStreamProtocol:member(1)", "docComment": "/**\n * Registers a protocol of `scheme` that will send a stream as a response.\n *\n * @param scheme - The scheme to register.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerStreamProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "!\"\\\"node:stream\\\"\".__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "registerStreamProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#registerStringProtocol:member(1)", "docComment": "/**\n * Registers a protocol of `scheme` that will send a `string` as a response.\n *\n * @param scheme - The scheme to register.\n *\n * @param handler - Called with the request and a callback to send the response.\n *\n * @returns Whether the protocol was successfully registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerStringProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(request: " }, { "kind": "Reference", "text": "ElectronProtocolRequest", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronProtocolResponse", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface" }, { "kind": "Content", "text": " | string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "registerStringProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#uninterceptProtocol:member(1)", "docComment": "/**\n * Removes the interceptor installed for `scheme` and restores its original handler.\n *\n * @param scheme - The scheme to unintercept.\n *\n * @returns Whether the protocol was successfully unintercepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uninterceptProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "uninterceptProtocol" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProtocol#unregisterProtocol:member(1)", "docComment": "/**\n * Unregisters the custom protocol of `scheme`.\n *\n * @param scheme - The scheme to unregister.\n *\n * @returns Whether the protocol was successfully unregistered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unregisterProtocol(scheme: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scheme", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unregisterProtocol" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProtocolRequest:interface", "docComment": "/**\n * A request passed to a protocol handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProtocolRequest " } ], "fileUrlPath": "src/electron/internals/ElectronProtocolRequest.d.ts", "releaseTag": "Public", "name": "ElectronProtocolRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolRequest#headers:member", "docComment": "/**\n * The request headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headers: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolRequest#method:member", "docComment": "/**\n * The HTTP request method.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolRequest#referrer:member", "docComment": "/**\n * The referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolRequest#uploadData:member", "docComment": "/**\n * The upload data for the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uploadData?: " }, { "kind": "Reference", "text": "ElectronUploadData", "canonicalReference": "obsidian-typings!ElectronUploadData:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "uploadData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolRequest#url:member", "docComment": "/**\n * The request URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProtocolResponse:interface", "docComment": "/**\n * A response returned from a protocol handler callback.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProtocolResponse " } ], "fileUrlPath": "src/electron/internals/ElectronProtocolResponse.d.ts", "releaseTag": "Public", "name": "ElectronProtocolResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#charset:member", "docComment": "/**\n * The charset of the response body.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "charset?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "charset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#data:member", "docComment": "/**\n * The response body, as a `Buffer`, `string`, or readable stream depending on the response type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data?: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "!\"\\\"node:stream\\\"\".__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#error:member", "docComment": "/**\n * When assigned, the request will fail with this error number. See the net error list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "error?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "error", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#headers:member", "docComment": "/**\n * An object containing the response headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headers?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string | string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#method:member", "docComment": "/**\n * The HTTP method. Only used for file and URL responses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "method?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#mimeType:member", "docComment": "/**\n * The MIME type of the response body.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mimeType?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mimeType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#path:member", "docComment": "/**\n * Path to the file which would be sent as the response body. Only used for file responses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#referrer:member", "docComment": "/**\n * The referrer URL. Only used for file and URL responses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "referrer?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "referrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#session:member", "docComment": "/**\n * The session used for requesting the URL. Setting to `null` uses a random independent session. Only used for URL responses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "session?: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#statusCode:member", "docComment": "/**\n * The HTTP response code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusCode?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "statusCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#uploadData:member", "docComment": "/**\n * The data used as upload data. Only used for URL responses when `method` is `POST`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uploadData?: " }, { "kind": "Reference", "text": "ElectronProtocolResponseUploadData", "canonicalReference": "obsidian-typings!ElectronProtocolResponseUploadData:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "uploadData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponse#url:member", "docComment": "/**\n * Download the URL and pipe the result as the response body. Only used for URL responses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProtocolResponseUploadData:interface", "docComment": "/**\n * Upload data used as the body of a protocol response for `POST` requests.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProtocolResponseUploadData " } ], "fileUrlPath": "src/electron/internals/ElectronProtocolResponseUploadData.d.ts", "releaseTag": "Public", "name": "ElectronProtocolResponseUploadData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponseUploadData#contentType:member", "docComment": "/**\n * MIME type of the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronProtocolResponseUploadData#data:member", "docComment": "/**\n * Content to be sent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronProvider:interface", "docComment": "/**\n * A spell check provider for input fields and text areas.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronProvider " } ], "fileUrlPath": "src/electron/internals/ElectronProvider.d.ts", "releaseTag": "Public", "name": "ElectronProvider", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronProvider#spellCheck:member(1)", "docComment": "/**\n * Runs spell checking asynchronously on an array of individual words and reports the misspelt ones.\n *\n * @param words - The words to spell check.\n *\n * @param callback - Called with the array of misspelt words when spell checking completes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "spellCheck(words: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(misspeltWords: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "words", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "spellCheck" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronRectangle:interface", "docComment": "/**\n * Represents a rectangle with position and dimensions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronRectangle " } ], "fileUrlPath": "src/electron/internals/ElectronRectangle.d.ts", "releaseTag": "Public", "name": "ElectronRectangle", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRectangle#height:member", "docComment": "/**\n * The height of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRectangle#width:member", "docComment": "/**\n * The width of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRectangle#x:member", "docComment": "/**\n * The x coordinate of the origin of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRectangle#y:member", "docComment": "/**\n * The y coordinate of the origin of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronReferrer:interface", "docComment": "/**\n * Represents an HTTP referrer and its policy.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronReferrer " } ], "fileUrlPath": "src/electron/internals/ElectronReferrer.d.ts", "releaseTag": "Public", "name": "ElectronReferrer", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronReferrer#policy:member", "docComment": "/**\n * The referrer policy. See the Referrer-Policy spec for more details on the meaning of these values.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "policy: " }, { "kind": "Content", "text": "'default' | 'no-referrer-when-downgrade' | 'no-referrer' | 'origin' | 'same-origin' | 'strict-origin-when-cross-origin' | 'strict-origin' | 'unsafe-url'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "policy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronReferrer#url:member", "docComment": "/**\n * HTTP Referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronRegistrationCompletedDetails:interface", "docComment": "/**\n * Details of a completed service worker registration.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronRegistrationCompletedDetails " } ], "fileUrlPath": "src/electron/internals/ElectronRegistrationCompletedDetails.d.ts", "releaseTag": "Public", "name": "ElectronRegistrationCompletedDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRegistrationCompletedDetails#scope:member", "docComment": "/**\n * The base URL that a service worker is registered for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scope: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronRelaunchOptions:interface", "docComment": "/**\n * Options for relaunching the application.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronRelaunchOptions " } ], "fileUrlPath": "src/electron/internals/ElectronRelaunchOptions.d.ts", "releaseTag": "Public", "name": "ElectronRelaunchOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRelaunchOptions#args:member", "docComment": "/**\n * The command line arguments to pass to the relaunched instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRelaunchOptions#execPath:member", "docComment": "/**\n * The executable to run for the relaunch instead of the current app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "execPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "execPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronRemote:interface", "docComment": "/**\n * Electron `@electron/remote` module for accessing main process modules from the renderer.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronRemote " } ], "fileUrlPath": "src/electron/internals/ElectronRemote.d.ts", "releaseTag": "Public", "name": "ElectronRemote", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#app:member", "docComment": "/**\n * The main process app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "ElectronApp", "canonicalReference": "obsidian-typings!ElectronApp:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#autoUpdater:member", "docComment": "/**\n * The main process `autoUpdater` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoUpdater: " }, { "kind": "Reference", "text": "ElectronAutoUpdater", "canonicalReference": "obsidian-typings!ElectronAutoUpdater:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "autoUpdater", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#BrowserView:member", "docComment": "/**\n * The `BrowserView` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BrowserView: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronBrowserView", "canonicalReference": "obsidian-typings!ElectronBrowserView:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "BrowserView", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#BrowserWindow:member", "docComment": "/**\n * The `BrowserWindow` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BrowserWindow: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "BrowserWindow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#clipboard:member", "docComment": "/**\n * The main process `clipboard` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clipboard: " }, { "kind": "Reference", "text": "ElectronClipboard", "canonicalReference": "obsidian-typings!ElectronClipboard:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clipboard", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#contentTracing:member", "docComment": "/**\n * The main process `contentTracing` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentTracing: " }, { "kind": "Reference", "text": "ElectronContentTracing", "canonicalReference": "obsidian-typings!ElectronContentTracing:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentTracing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#crashReporter:member", "docComment": "/**\n * The main process `crashReporter` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "crashReporter: " }, { "kind": "Reference", "text": "ElectronCrashReporter", "canonicalReference": "obsidian-typings!ElectronCrashReporter:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "crashReporter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronRemote#createFunctionWithReturnValue:member(1)", "docComment": "/**\n * Wraps a value in a function that returns it, for passing across the remote boundary.\n *\n * @param returnValue - The value the created function should return.\n *\n * @returns A function returning `returnValue`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFunctionWithReturnValue<T>(returnValue: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "() => T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "returnValue", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createFunctionWithReturnValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#desktopCapturer:member", "docComment": "/**\n * The main process `desktopCapturer` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "desktopCapturer: " }, { "kind": "Reference", "text": "ElectronDesktopCapturer", "canonicalReference": "obsidian-typings!ElectronDesktopCapturer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "desktopCapturer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#dialog:member", "docComment": "/**\n * The main process `dialog` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dialog: " }, { "kind": "Reference", "text": "ElectronDialog", "canonicalReference": "obsidian-typings!ElectronDialog:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dialog", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronRemote#getBuiltin:member(1)", "docComment": "/**\n * Returns the main process module built into Electron with the given name.\n *\n * @param name - The built-in module name.\n *\n * @returns The requested built-in module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBuiltin(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getBuiltin" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronRemote#getCurrentWebContents:member(1)", "docComment": "/**\n * Returns the web contents of the current renderer process.\n *\n * @returns The current web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCurrentWebContents(): " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCurrentWebContents" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronRemote#getCurrentWindow:member(1)", "docComment": "/**\n * Returns the BrowserWindow of the current renderer process.\n *\n * @returns The current BrowserWindow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCurrentWindow(): " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCurrentWindow" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronRemote#getGlobal:member(1)", "docComment": "/**\n * Returns the global variable of the given name from the main process.\n *\n * @param name - The global variable name.\n *\n * @returns The requested global value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGlobal(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getGlobal" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#globalShortcut:member", "docComment": "/**\n * The main process `globalShortcut` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "globalShortcut: " }, { "kind": "Reference", "text": "ElectronGlobalShortcut", "canonicalReference": "obsidian-typings!ElectronGlobalShortcut:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "globalShortcut", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#inAppPurchase:member", "docComment": "/**\n * The main process `inAppPurchase` module. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inAppPurchase: " }, { "kind": "Reference", "text": "ElectronInAppPurchase", "canonicalReference": "obsidian-typings!ElectronInAppPurchase:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inAppPurchase", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#ipcMain:member", "docComment": "/**\n * The main process `ipcMain` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ipcMain: " }, { "kind": "Reference", "text": "ElectronIpcMain", "canonicalReference": "obsidian-typings!ElectronIpcMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ipcMain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#Menu:member", "docComment": "/**\n * The `Menu` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Menu: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Menu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#MenuItem:member", "docComment": "/**\n * The `MenuItem` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "MenuItem: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronMenuItem", "canonicalReference": "obsidian-typings!ElectronMenuItem:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "MenuItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#MessageChannelMain:member", "docComment": "/**\n * The `MessageChannelMain` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "MessageChannelMain: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronMessageChannelMain", "canonicalReference": "obsidian-typings!ElectronMessageChannelMain:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "MessageChannelMain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#nativeImage:member", "docComment": "/**\n * The main process `nativeImage` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nativeImage: " }, { "kind": "Reference", "text": "ElectronNativeImageModule", "canonicalReference": "obsidian-typings!ElectronNativeImageModule:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nativeImage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#nativeTheme:member", "docComment": "/**\n * The main process `nativeTheme` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nativeTheme: " }, { "kind": "Reference", "text": "ElectronNativeTheme", "canonicalReference": "obsidian-typings!ElectronNativeTheme:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nativeTheme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#net:member", "docComment": "/**\n * The main process `net` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "net: " }, { "kind": "Reference", "text": "ElectronNet", "canonicalReference": "obsidian-typings!ElectronNet:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "net", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#netLog:member", "docComment": "/**\n * The main process `netLog` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "netLog: " }, { "kind": "Reference", "text": "ElectronNetLog", "canonicalReference": "obsidian-typings!ElectronNetLog:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "netLog", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#Notification:member", "docComment": "/**\n * The `Notification` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Notification: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronNotification", "canonicalReference": "obsidian-typings!ElectronNotification:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Notification", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#powerMonitor:member", "docComment": "/**\n * The main process `powerMonitor` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "powerMonitor: " }, { "kind": "Reference", "text": "ElectronPowerMonitor", "canonicalReference": "obsidian-typings!ElectronPowerMonitor:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "powerMonitor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#powerSaveBlocker:member", "docComment": "/**\n * The main process `powerSaveBlocker` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "powerSaveBlocker: " }, { "kind": "Reference", "text": "ElectronPowerSaveBlocker", "canonicalReference": "obsidian-typings!ElectronPowerSaveBlocker:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "powerSaveBlocker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#process:member", "docComment": "/**\n * The main process `process` object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "process: " }, { "kind": "Reference", "text": "NodeJS.Process", "canonicalReference": "!\"\\\"node:process\\\"\".__global.NodeJS.Process:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "process", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#protocol:member", "docComment": "/**\n * The main process `protocol` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protocol: " }, { "kind": "Reference", "text": "ElectronProtocol", "canonicalReference": "obsidian-typings!ElectronProtocol:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "protocol", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronRemote#require:member(1)", "docComment": "/**\n * Returns the module required from the main process by the given path.\n *\n * @param module - The module path to require.\n *\n * @returns The required module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "require(module: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "module", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "require" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#safeStorage:member", "docComment": "/**\n * The main process `safeStorage` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "safeStorage: " }, { "kind": "Reference", "text": "ElectronSafeStorage", "canonicalReference": "obsidian-typings!ElectronSafeStorage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "safeStorage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#screen:member", "docComment": "/**\n * The main process `screen` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "screen: " }, { "kind": "Reference", "text": "ElectronScreen", "canonicalReference": "obsidian-typings!ElectronScreen:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "screen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#session:member", "docComment": "/**\n * The main process `session` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "session: " }, { "kind": "Reference", "text": "ElectronSessionModule", "canonicalReference": "obsidian-typings!ElectronSessionModule:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#ShareMenu:member", "docComment": "/**\n * The `ShareMenu` constructor. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ShareMenu: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronShareMenu", "canonicalReference": "obsidian-typings!ElectronShareMenu:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ShareMenu", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#shell:member", "docComment": "/**\n * The main process `shell` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shell: " }, { "kind": "Reference", "text": "ElectronShell", "canonicalReference": "obsidian-typings!ElectronShell:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "shell", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#systemPreferences:member", "docComment": "/**\n * The main process `systemPreferences` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "systemPreferences: " }, { "kind": "Reference", "text": "ElectronSystemPreferences", "canonicalReference": "obsidian-typings!ElectronSystemPreferences:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "systemPreferences", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#TouchBar:member", "docComment": "/**\n * The `TouchBar` constructor. macOS only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TouchBar: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBar", "canonicalReference": "obsidian-typings!ElectronTouchBar:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#Tray:member", "docComment": "/**\n * The `Tray` constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Tray: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTray", "canonicalReference": "obsidian-typings!ElectronTray:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Tray", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#webContents:member", "docComment": "/**\n * The main process `webContents` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webContents: " }, { "kind": "Reference", "text": "ElectronWebContentsModule", "canonicalReference": "obsidian-typings!ElectronWebContentsModule:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRemote#webFrameMain:member", "docComment": "/**\n * The main process `webFrameMain` module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webFrameMain: " }, { "kind": "Reference", "text": "ElectronWebFrameMainModule", "canonicalReference": "obsidian-typings!ElectronWebFrameMainModule:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webFrameMain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface", "docComment": "/**\n * Details about a renderer process that has gone (crashed or killed).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronRenderProcessGoneDetails " } ], "fileUrlPath": "src/electron/internals/ElectronRenderProcessGoneDetails.d.ts", "releaseTag": "Public", "name": "ElectronRenderProcessGoneDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails#exitCode:member", "docComment": "/**\n * The exit code of the process, unless `reason` is `launch-failed`, in which case it is a platform-specific launch failure error code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exitCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "exitCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails#reason:member", "docComment": "/**\n * The reason the render process is gone.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reason: " }, { "kind": "Content", "text": "'abnormal-exit' | 'clean-exit' | 'crashed' | 'integrity-failure' | 'killed' | 'launch-failed' | 'oom'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "reason", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronRequest:interface", "docComment": "/**\n * A certificate verification request passed to a certificate verify proc.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronRequest " } ], "fileUrlPath": "src/electron/internals/ElectronRequest.d.ts", "releaseTag": "Public", "name": "ElectronRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRequest#certificate:member", "docComment": "/**\n * The certificate presented by the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "certificate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRequest#errorCode:member", "docComment": "/**\n * The error code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "errorCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "errorCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRequest#hostname:member", "docComment": "/**\n * The host name being verified.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hostname: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hostname", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRequest#isIssuedByKnownRoot:member", "docComment": "/**\n * Whether Chromium recognises the root CA as a standard root.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isIssuedByKnownRoot: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isIssuedByKnownRoot", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRequest#validatedCertificate:member", "docComment": "/**\n * The certificate as validated by Chromium.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "validatedCertificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "validatedCertificate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronRequest#verificationResult:member", "docComment": "/**\n * `OK` if the certificate is trusted, otherwise an error like `CERT_REVOKED`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "verificationResult: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "verificationResult", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronResizeOptions:interface", "docComment": "/**\n * Options for `NativeImage.resize`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronResizeOptions " } ], "fileUrlPath": "src/electron/internals/ElectronResizeOptions.d.ts", "releaseTag": "Public", "name": "ElectronResizeOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResizeOptions#height:member", "docComment": "/**\n * The desired height of the resized image. Defaults to the image's height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResizeOptions#quality:member", "docComment": "/**\n * The desired quality of the resized image. Possible values are `best`, `better`, or `good`. These values express a desired quality/speed tradeoff that is translated into an algorithm-specific method depending on the capabilities (CPU, GPU) of the underlying platform.\n *\n * @default\n *\n * `'best'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "quality?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "quality", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResizeOptions#width:member", "docComment": "/**\n * The desired width of the resized image. Defaults to the image's width.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronResourceUsage:interface", "docComment": "/**\n * Usage information of Blink's internal memory caches.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronResourceUsage " } ], "fileUrlPath": "src/electron/internals/ElectronResourceUsage.d.ts", "releaseTag": "Public", "name": "ElectronResourceUsage", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResourceUsage#cssStyleSheets:member", "docComment": "/**\n * Usage details for the CSS style sheets cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cssStyleSheets: " }, { "kind": "Reference", "text": "ElectronMemoryUsageDetails", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cssStyleSheets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResourceUsage#fonts:member", "docComment": "/**\n * Usage details for the fonts cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fonts: " }, { "kind": "Reference", "text": "ElectronMemoryUsageDetails", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fonts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResourceUsage#images:member", "docComment": "/**\n * Usage details for the images cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "images: " }, { "kind": "Reference", "text": "ElectronMemoryUsageDetails", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "images", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResourceUsage#other:member", "docComment": "/**\n * Usage details for other cached resources.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "other: " }, { "kind": "Reference", "text": "ElectronMemoryUsageDetails", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "other", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResourceUsage#scripts:member", "docComment": "/**\n * Usage details for the scripts cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scripts: " }, { "kind": "Reference", "text": "ElectronMemoryUsageDetails", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scripts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResourceUsage#xslStyleSheets:member", "docComment": "/**\n * Usage details for the XSL style sheets cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "xslStyleSheets: " }, { "kind": "Reference", "text": "ElectronMemoryUsageDetails", "canonicalReference": "obsidian-typings!ElectronMemoryUsageDetails:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "xslStyleSheets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronResponse:interface", "docComment": "/**\n * Response object returned by an `onBeforeRequest` web-request listener callback.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronResponse " } ], "fileUrlPath": "src/electron/internals/ElectronResponse.d.ts", "releaseTag": "Public", "name": "ElectronResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResponse#cancel:member", "docComment": "/**\n * Whether to cancel the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cancel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResponse#redirectURL:member", "docComment": "/**\n * The original request is prevented from being sent or completed and is instead redirected to the given URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redirectURL?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "redirectURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronResult:interface", "docComment": "/**\n * The result of a find-in-page request.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronResult " } ], "fileUrlPath": "src/electron/internals/ElectronResult.d.ts", "releaseTag": "Public", "name": "ElectronResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResult#activeMatchOrdinal:member", "docComment": "/**\n * Position of the active match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "activeMatchOrdinal: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "activeMatchOrdinal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResult#finalUpdate:member", "docComment": "/**\n * Whether this is the final update for the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "finalUpdate: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "finalUpdate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResult#matches:member", "docComment": "/**\n * Number of matches.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "matches: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "matches", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResult#requestId:member", "docComment": "/**\n * The request id used for the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronResult#selectionArea:member", "docComment": "/**\n * Coordinates of the first match region.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectionArea: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectionArea", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSafeStorage:interface", "docComment": "/**\n * Electron `safeStorage` module for encrypting and decrypting strings using OS-level cryptography.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSafeStorage extends " }, { "kind": "Reference", "text": "NodeJS.EventEmitter", "canonicalReference": "!\"\\\"node:events\\\"\".__global.NodeJS.EventEmitter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronSafeStorage.d.ts", "releaseTag": "Public", "name": "ElectronSafeStorage", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSafeStorage#decryptString:member(1)", "docComment": "/**\n * Decrypts the encrypted buffer obtained with `encryptString` back into a string.\n *\n * This function will throw an error if decryption fails.\n *\n * @param encrypted - The buffer produced by `encryptString`.\n *\n * @returns The decrypted string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "decryptString(encrypted: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "encrypted", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "decryptString" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSafeStorage#encryptString:member(1)", "docComment": "/**\n * Encrypts a string using OS-level cryptography.\n *\n * This function will throw an error if encryption fails.\n *\n * @param plainText - The string to encrypt.\n *\n * @returns A buffer of bytes representing the encrypted string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "encryptString(plainText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "plainText", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "encryptString" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSafeStorage#isEncryptionAvailable:member(1)", "docComment": "/**\n * Whether encryption is available.\n *\n * On Linux, returns `true` if the app has emitted the `ready` event and the secret key is available. On macOS, returns `true` if Keychain is available. On Windows, returns `true` once the app has emitted the `ready` event.\n *\n * @returns `true` if string encryption is available on the current platform.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEncryptionAvailable(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isEncryptionAvailable" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions:interface", "docComment": "/**\n * Options for Electron save file dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSaveDialogOptions " } ], "fileUrlPath": "src/electron/internals/ElectronSaveDialogOptions.d.ts", "releaseTag": "Public", "name": "ElectronSaveDialogOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#buttonLabel:member", "docComment": "/**\n * The label for the confirmation button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttonLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "buttonLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#defaultPath:member", "docComment": "/**\n * The default path to open the dialog at.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#filters:member", "docComment": "/**\n * The file filters to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters?: " }, { "kind": "Reference", "text": "ElectronFileFilter", "canonicalReference": "obsidian-typings!ElectronFileFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#message:member", "docComment": "/**\n * The message to display above the dialog on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#nameFieldLabel:member", "docComment": "/**\n * The label for the file name text field on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nameFieldLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nameFieldLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#properties:member", "docComment": "/**\n * The dialog behavior properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<'createDirectory' | 'dontAddToRecent' | 'showHiddenFiles' | 'showOverwriteConfirmation' | 'treatPackageAsDirectory'>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#securityScopedBookmarks:member", "docComment": "/**\n * Whether to create a security scoped bookmark when packaged for the Mac App Store (macOS, mas only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "securityScopedBookmarks?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "securityScopedBookmarks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#showsTagField:member", "docComment": "/**\n * Whether to show the tags field on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showsTagField?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showsTagField", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogOptions#title:member", "docComment": "/**\n * The dialog title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSaveDialogReturnValue:interface", "docComment": "/**\n * Return value from an Electron save file dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSaveDialogReturnValue " } ], "fileUrlPath": "src/electron/internals/ElectronSaveDialogReturnValue.d.ts", "releaseTag": "Public", "name": "ElectronSaveDialogReturnValue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogReturnValue#bookmark:member", "docComment": "/**\n * Base64 encoded string which contains the security scoped bookmark data for the saved file (macOS, mas only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bookmark?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "bookmark", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogReturnValue#canceled:member", "docComment": "/**\n * Whether the dialog was canceled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canceled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canceled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogReturnValue#filePath:member", "docComment": "/**\n * The file path chosen by the user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filePath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions:interface", "docComment": "/**\n * Options for Electron synchronous save file dialog.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSaveDialogSyncOptions " } ], "fileUrlPath": "src/electron/internals/ElectronSaveDialogSyncOptions.d.ts", "releaseTag": "Public", "name": "ElectronSaveDialogSyncOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#buttonLabel:member", "docComment": "/**\n * The label for the confirmation button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttonLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "buttonLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#defaultPath:member", "docComment": "/**\n * The default path to open the dialog at.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#filters:member", "docComment": "/**\n * The file filters to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters?: " }, { "kind": "Reference", "text": "ElectronFileFilter", "canonicalReference": "obsidian-typings!ElectronFileFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#message:member", "docComment": "/**\n * The message to display above the dialog on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#nameFieldLabel:member", "docComment": "/**\n * The label for the file name text field on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nameFieldLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nameFieldLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#properties:member", "docComment": "/**\n * The dialog behavior properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<'createDirectory' | 'dontAddToRecent' | 'showHiddenFiles' | 'showOverwriteConfirmation' | 'treatPackageAsDirectory'>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#securityScopedBookmarks:member", "docComment": "/**\n * Whether to create a security scoped bookmark when packaged for the Mac App Store (macOS, mas only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "securityScopedBookmarks?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "securityScopedBookmarks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#showsTagField:member", "docComment": "/**\n * Whether to show the tags field on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showsTagField?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showsTagField", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSaveDialogSyncOptions#title:member", "docComment": "/**\n * The dialog title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronScreen:interface", "docComment": "/**\n * Electron Screen for retrieving information about screen size, displays, cursor position, and so on.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronScreen " } ], "fileUrlPath": "src/electron/internals/ElectronScreen.d.ts", "releaseTag": "Public", "name": "ElectronScreen", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#addListener:member(1)", "docComment": "/**\n * Adds a listener for the `display-added` event.\n *\n * Emitted when `newDisplay` has been added.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'display-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newDisplay: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#addListener:member(2)", "docComment": "/**\n * Adds a listener for the `display-metrics-changed` event.\n *\n * Emitted when one or more metrics change in a `display`. The `changedMetrics` is an array of strings that describe the changes. Possible changes are `bounds`, `workArea`, `scaleFactor` and `rotation`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'display-metrics-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", display: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ", changedMetrics: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#addListener:member(3)", "docComment": "/**\n * Adds a listener for the `display-removed` event.\n *\n * Emitted when `oldDisplay` has been removed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'display-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", oldDisplay: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#dipToScreenPoint:member(1)", "docComment": "/**\n * Converts a screen DIP point to a screen physical point. The DPI scale is performed relative to the display containing the DIP point.\n *\n * @param point - The screen DIP point to convert.\n *\n * @returns The corresponding screen physical point.\n *\n * Platform: `win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dipToScreenPoint(point: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "point", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "dipToScreenPoint" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#dipToScreenRect:member(1)", "docComment": "/**\n * Converts a screen DIP rect to a screen physical rect. The DPI scale is performed relative to the display nearest to `window`. If `window` is `null`, scaling will be performed to the display nearest to `rect`.\n *\n * @param window - The window used to determine the display, or `null`.\n *\n * @param rect - The screen DIP rect to convert.\n *\n * @returns The corresponding screen physical rect.\n *\n * Platform: `win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dipToScreenRect(window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", rect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "window", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "dipToScreenRect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#getAllDisplays:member(1)", "docComment": "/**\n * Returns an array of displays that are currently available.\n *\n * @returns The available displays.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAllDisplays(): " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAllDisplays" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#getCursorScreenPoint:member(1)", "docComment": "/**\n * Returns the current absolute position of the mouse pointer.\n *\n * **Note:** The return value is a DIP point, not a screen physical point.\n *\n * @returns The current absolute position of the mouse pointer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCursorScreenPoint(): " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCursorScreenPoint" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#getDisplayMatching:member(1)", "docComment": "/**\n * Returns the display that most closely intersects the provided bounds.\n *\n * @param rect - The bounds to match against.\n *\n * @returns The display that most closely intersects the provided bounds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDisplayMatching(rect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDisplayMatching" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#getDisplayNearestPoint:member(1)", "docComment": "/**\n * Returns the display nearest the specified point.\n *\n * @param point - The point to find the nearest display for.\n *\n * @returns The display nearest the specified point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDisplayNearestPoint(point: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "point", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDisplayNearestPoint" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#getPrimaryDisplay:member(1)", "docComment": "/**\n * Returns the primary display.\n *\n * @returns The primary display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPrimaryDisplay(): " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPrimaryDisplay" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#on:member(1)", "docComment": "/**\n * Registers a listener for the `display-added` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'display-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newDisplay: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#on:member(2)", "docComment": "/**\n * Registers a listener for the `display-metrics-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'display-metrics-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", display: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ", changedMetrics: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#on:member(3)", "docComment": "/**\n * Registers a listener for the `display-removed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'display-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", oldDisplay: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `display-added` event. The listener is removed after it is invoked once.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'display-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newDisplay: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `display-metrics-changed` event. The listener is removed after it is invoked once.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'display-metrics-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", display: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ", changedMetrics: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#once:member(3)", "docComment": "/**\n * Registers a one-time listener for the `display-removed` event. The listener is removed after it is invoked once.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'display-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", oldDisplay: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#removeListener:member(1)", "docComment": "/**\n * Removes the specified listener for the `display-added` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'display-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newDisplay: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#removeListener:member(2)", "docComment": "/**\n * Removes the specified listener for the `display-metrics-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'display-metrics-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", display: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ", changedMetrics: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#removeListener:member(3)", "docComment": "/**\n * Removes the specified listener for the `display-removed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This `ElectronScreen` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'display-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", oldDisplay: " }, { "kind": "Reference", "text": "ElectronDisplay", "canonicalReference": "obsidian-typings!ElectronDisplay:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#screenToDipPoint:member(1)", "docComment": "/**\n * Converts a screen physical point to a screen DIP point. The DPI scale is performed relative to the display containing the physical point.\n *\n * @param point - The screen physical point to convert.\n *\n * @returns The corresponding screen DIP point.\n *\n * Platform: `win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "screenToDipPoint(point: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "point", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "screenToDipPoint" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronScreen#screenToDipRect:member(1)", "docComment": "/**\n * Converts a screen physical rect to a screen DIP rect. The DPI scale is performed relative to the display nearest to `window`. If `window` is `null`, scaling will be performed to the display nearest to `rect`.\n *\n * @param window - The window used to determine the display, or `null`.\n *\n * @param rect - The screen physical rect to convert.\n *\n * @returns The corresponding screen DIP rect.\n *\n * Platform: `win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "screenToDipRect(window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", rect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "window", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "screenToDipRect" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronScrubberItem:interface", "docComment": "/**\n * An item shown in a {@link ElectronTouchBarScrubber}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronScrubberItem " } ], "fileUrlPath": "src/electron/internals/ElectronScrubberItem.d.ts", "releaseTag": "Public", "name": "ElectronScrubberItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronScrubberItem#icon:member", "docComment": "/**\n * The image to appear in this item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronScrubberItem#label:member", "docComment": "/**\n * The text to appear in this item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSegmentedControlSegment:interface", "docComment": "/**\n * A segment shown in a {@link ElectronTouchBarSegmentedControl}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSegmentedControlSegment " } ], "fileUrlPath": "src/electron/internals/ElectronSegmentedControlSegment.d.ts", "releaseTag": "Public", "name": "ElectronSegmentedControlSegment", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSegmentedControlSegment#enabled:member", "docComment": "/**\n * Whether this segment is selectable.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSegmentedControlSegment#icon:member", "docComment": "/**\n * The image to appear in this segment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSegmentedControlSegment#label:member", "docComment": "/**\n * The text to appear in this segment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSelectHidDeviceDetails:interface", "docComment": "/**\n * Details passed to the `select-hid-device` session event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSelectHidDeviceDetails " } ], "fileUrlPath": "src/electron/internals/ElectronSelectHidDeviceDetails.d.ts", "releaseTag": "Public", "name": "ElectronSelectHidDeviceDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSelectHidDeviceDetails#deviceList:member", "docComment": "/**\n * The list of HID devices available for selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceList: " }, { "kind": "Reference", "text": "ElectronHIDDevice", "canonicalReference": "obsidian-typings!ElectronHIDDevice:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deviceList", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSelectHidDeviceDetails#frame:member", "docComment": "/**\n * The frame that requested a device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface", "docComment": "/**\n * A serial port available for selection via the Web Serial API.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSerialPort " } ], "fileUrlPath": "src/electron/internals/ElectronSerialPort.d.ts", "releaseTag": "Public", "name": "ElectronSerialPort", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSerialPort#deviceInstanceId:member", "docComment": "/**\n * A stable identifier on Windows that can be used for device permissions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceInstanceId?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "deviceInstanceId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSerialPort#displayName:member", "docComment": "/**\n * A string suitable for display to the user for describing this device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "displayName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSerialPort#portId:member", "docComment": "/**\n * Unique identifier for the port.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "portId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "portId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSerialPort#portName:member", "docComment": "/**\n * Name of the port.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "portName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "portName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSerialPort#productId:member", "docComment": "/**\n * Optional USB product ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "productId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "productId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSerialPort#serialNumber:member", "docComment": "/**\n * The USB device serial number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialNumber: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "serialNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSerialPort#usbDriverName:member", "docComment": "/**\n * Represents a single serial port on macOS that can be enumerated by multiple drivers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "usbDriverName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "usbDriverName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSerialPort#vendorId:member", "docComment": "/**\n * Optional USB vendor ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vendorId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vendorId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronServiceWorkerInfo:interface", "docComment": "/**\n * Information about a running service worker.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronServiceWorkerInfo " } ], "fileUrlPath": "src/electron/internals/ElectronServiceWorkerInfo.d.ts", "releaseTag": "Public", "name": "ElectronServiceWorkerInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkerInfo#renderProcessId:member", "docComment": "/**\n * The virtual ID of the process that this service worker is running in. Not an OS-level PID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderProcessId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderProcessId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkerInfo#scope:member", "docComment": "/**\n * The base URL that this service worker is active for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scope: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkerInfo#scriptUrl:member", "docComment": "/**\n * The full URL to the script that this service worker runs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scriptUrl: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scriptUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronServiceWorkers:interface", "docComment": "/**\n * Provides access to the service workers registered within a session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronServiceWorkers " } ], "fileUrlPath": "src/electron/internals/ElectronServiceWorkers.d.ts", "releaseTag": "Public", "name": "ElectronServiceWorkers", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#addListener:member(1)", "docComment": "/**\n * Registers a listener for the `console-message` event, emitted when a service worker logs to the console.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the console message details.\n *\n * @returns This service workers instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'console-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", messageDetails: " }, { "kind": "Reference", "text": "ElectronMessageDetails", "canonicalReference": "obsidian-typings!ElectronMessageDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#addListener:member(2)", "docComment": "/**\n * Registers a listener for the `registration-completed` event, emitted when a service worker has been registered.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the registration details.\n *\n * @returns This service workers instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'registration-completed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRegistrationCompletedDetails", "canonicalReference": "obsidian-typings!ElectronRegistrationCompletedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#getAllRunning:member(1)", "docComment": "/**\n * Returns all running service workers keyed by version ID.\n *\n * @returns A map whose keys are the service worker version IDs and whose values describe each service worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAllRunning(): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<number, " }, { "kind": "Reference", "text": "ElectronServiceWorkerInfo", "canonicalReference": "obsidian-typings!ElectronServiceWorkerInfo:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAllRunning" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#getFromVersionID:member(1)", "docComment": "/**\n * Returns information about the service worker with the given version ID.\n *\n * @param versionId - The service worker version ID.\n *\n * @returns Information about the service worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFromVersionID(versionId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronServiceWorkerInfo", "canonicalReference": "obsidian-typings!ElectronServiceWorkerInfo:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "versionId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFromVersionID" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#on:member(1)", "docComment": "/**\n * Registers a listener for the `console-message` event, emitted when a service worker logs to the console.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the console message details.\n *\n * @returns This service workers instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'console-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", messageDetails: " }, { "kind": "Reference", "text": "ElectronMessageDetails", "canonicalReference": "obsidian-typings!ElectronMessageDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#on:member(2)", "docComment": "/**\n * Registers a listener for the `registration-completed` event, emitted when a service worker has been registered.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the registration details.\n *\n * @returns This service workers instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'registration-completed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRegistrationCompletedDetails", "canonicalReference": "obsidian-typings!ElectronRegistrationCompletedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `console-message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the console message details.\n *\n * @returns This service workers instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'console-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", messageDetails: " }, { "kind": "Reference", "text": "ElectronMessageDetails", "canonicalReference": "obsidian-typings!ElectronMessageDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `registration-completed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called with the registration details.\n *\n * @returns This service workers instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'registration-completed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRegistrationCompletedDetails", "canonicalReference": "obsidian-typings!ElectronRegistrationCompletedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#removeListener:member(1)", "docComment": "/**\n * Removes a previously registered `console-message` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This service workers instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'console-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", messageDetails: " }, { "kind": "Reference", "text": "ElectronMessageDetails", "canonicalReference": "obsidian-typings!ElectronMessageDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronServiceWorkers#removeListener:member(2)", "docComment": "/**\n * Removes a previously registered `registration-completed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This service workers instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'registration-completed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRegistrationCompletedDetails", "canonicalReference": "obsidian-typings!ElectronRegistrationCompletedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSessionModule:interface", "docComment": "/**\n * The `session` module accessor exposed by Electron, providing the default session and a factory for partition-based sessions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSessionModule " } ], "fileUrlPath": "src/electron/internals/ElectronSessionModule.d.ts", "releaseTag": "Public", "name": "ElectronSessionModule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSessionModule#defaultSession:member", "docComment": "/**\n * The default session object of the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultSession: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultSession", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSessionModule#fromPartition:member(1)", "docComment": "/**\n * Returns a session instance from a `partition` string. When there is an existing `Session` with the same `partition`, it will be returned; otherwise a new `Session` instance will be created with `options`.\n *\n * If `partition` starts with `persist:`, the page will use a persistent session available to all pages in the app with the same `partition`. If there is no `persist:` prefix, the page will use an in-memory session. If the `partition` is empty then default session of the app will be returned.\n *\n * @param partition - The partition string identifying the session.\n *\n * @param options - Options used when creating the session.\n *\n * @returns The `Session` instance for the given partition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromPartition(partition: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronFromPartitionOptions", "canonicalReference": "obsidian-typings!ElectronFromPartitionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "partition", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "fromPartition" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSettings:interface", "docComment": "/**\n * Settings for the app's login item.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSettings " } ], "fileUrlPath": "src/electron/internals/ElectronSettings.d.ts", "releaseTag": "Public", "name": "ElectronSettings", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSettings#args:member", "docComment": "/**\n * The command-line arguments to pass to the executable. Windows only.\n *\n * @default\n *\n * `[]`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSettings#enabled:member", "docComment": "/**\n * `true` to change the startup approved registry key and enable/disable the app in Task Manager and Windows settings. Windows only.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSettings#name:member", "docComment": "/**\n * Value name to write into registry. Defaults to the app's AppUserModelId. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSettings#openAsHidden:member", "docComment": "/**\n * `true` to open the app as hidden. Not available on MAS builds. macOS only.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openAsHidden?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "openAsHidden", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSettings#openAtLogin:member", "docComment": "/**\n * `true` to open the app at login, `false` to remove the app as a login item.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openAtLogin?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "openAtLogin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSettings#path:member", "docComment": "/**\n * The executable to launch at login. Windows only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSharedWorkerInfo:interface", "docComment": "/**\n * Information about a shared worker.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSharedWorkerInfo " } ], "fileUrlPath": "src/electron/internals/ElectronSharedWorkerInfo.d.ts", "releaseTag": "Public", "name": "ElectronSharedWorkerInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSharedWorkerInfo#id:member", "docComment": "/**\n * The unique id of the shared worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSharedWorkerInfo#url:member", "docComment": "/**\n * The url of the shared worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronShareMenu:class", "docComment": "/**\n * Electron ShareMenu for presenting the native share sheet for a {@link ElectronSharingItem}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronShareMenu " } ], "fileUrlPath": "src/electron/internals/ElectronShareMenu.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronShareMenu", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronShareMenu:constructor(1)", "docComment": "/**\n * Create a new instance of {@link ElectronShareMenu}.\n *\n * @param sharingItem - The item to share.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(sharingItem: " }, { "kind": "Reference", "text": "ElectronSharingItem", "canonicalReference": "obsidian-typings!ElectronSharingItem:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "sharingItem", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronShareMenu#closePopup:member(1)", "docComment": "/**\n * Closes the context menu in the `browserWindow`.\n *\n * @param browserWindow - The window to close the popup in.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closePopup(browserWindow?: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "browserWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "closePopup" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronShareMenu#popup:member(1)", "docComment": "/**\n * Pops up this menu as a context menu in the `BrowserWindow`.\n *\n * @param options - Options for the popup including `window`, `x`, and `y`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "popup(options?: " }, { "kind": "Reference", "text": "ElectronMenuPopupOptions", "canonicalReference": "obsidian-typings!ElectronMenuPopupOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "popup" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSharingItem:interface", "docComment": "/**\n * Electron SharingItem describing the content to share via the `shareMenu` role.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSharingItem " } ], "fileUrlPath": "src/electron/internals/ElectronSharingItem.d.ts", "releaseTag": "Public", "name": "ElectronSharingItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSharingItem#filePaths:member", "docComment": "/**\n * An array of files to share.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filePaths?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filePaths", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSharingItem#texts:member", "docComment": "/**\n * An array of text to share.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "texts?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "texts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSharingItem#urls:member", "docComment": "/**\n * An array of URLs to share.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "urls?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "urls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronShell:interface", "docComment": "/**\n * Electron Shell for managing files and URLs using their default applications.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronShell " } ], "fileUrlPath": "src/electron/internals/ElectronShell.d.ts", "releaseTag": "Public", "name": "ElectronShell", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronShell#beep:member(1)", "docComment": "/**\n * Plays the system beep sound.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "beep(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "beep" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronShell#openExternal:member(1)", "docComment": "/**\n * Opens the given external protocol URL in the desktop's default manner (for example, `mailto:` URLs in the user's default mail agent).\n *\n * @param url - The URL to open.\n *\n * @param options - Options for opening the URL.\n *\n * @returns A `Promise` that resolves when the URL has been opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openExternal(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronShellOpenExternalOptions", "canonicalReference": "obsidian-typings!ElectronShellOpenExternalOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "openExternal" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronShell#openPath:member(1)", "docComment": "/**\n * Opens the given file in the desktop's default manner.\n *\n * @param path - The path to open.\n *\n * @returns A `Promise` that resolves with an error message if a failure occurred, otherwise an empty string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openPath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "openPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronShell#readShortcutLink:member(1)", "docComment": "/**\n * Resolves the shortcut link at `shortcutPath`. An exception is thrown when any error happens. Only available on Windows (`win32`).\n *\n * @param shortcutPath - The path to the shortcut link.\n *\n * @returns The details of the shortcut link.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readShortcutLink(shortcutPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronShortcutDetails", "canonicalReference": "obsidian-typings!ElectronShortcutDetails:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "shortcutPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "readShortcutLink" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronShell#showItemInFolder:member(1)", "docComment": "/**\n * Shows the given file in a file manager. If possible, selects the file.\n *\n * @param fullPath - The full path to the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showItemInFolder(fullPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fullPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showItemInFolder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronShell#trashItem:member(1)", "docComment": "/**\n * Moves a path to the OS-specific trash location (Trash on macOS, Recycle Bin on Windows, and a desktop-environment-specific location on Linux).\n *\n * @param path - The path to the file.\n *\n * @returns A `Promise` that resolves when the operation has completed and rejects if there was an error while deleting the requested item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trashItem(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "trashItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronShell#writeShortcutLink:member(1)", "docComment": "/**\n * Creates or updates a shortcut link at `shortcutPath`. Only available on Windows (`win32`).\n *\n * @param shortcutPath - The path to the shortcut link.\n *\n * @param operation - The operation to perform on the shortcut link.\n *\n * @param options - The details of the shortcut link.\n *\n * @returns Whether the shortcut was created successfully.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeShortcutLink(shortcutPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", operation: " }, { "kind": "Content", "text": "'create' | 'replace' | 'update'" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronShortcutDetails", "canonicalReference": "obsidian-typings!ElectronShortcutDetails:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "shortcutPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "operation", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "writeShortcutLink" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronShell#writeShortcutLink:member(2)", "docComment": "/**\n * Creates or updates a shortcut link at `shortcutPath`. Only available on Windows (`win32`).\n *\n * @param shortcutPath - The path to the shortcut link.\n *\n * @param options - The details of the shortcut link.\n *\n * @returns Whether the shortcut was created successfully.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "writeShortcutLink(shortcutPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "ElectronShortcutDetails", "canonicalReference": "obsidian-typings!ElectronShortcutDetails:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "shortcutPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "writeShortcutLink" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronShellOpenExternalOptions:interface", "docComment": "/**\n * Options for opening an external URL.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronShellOpenExternalOptions " } ], "fileUrlPath": "src/electron/internals/ElectronShellOpenExternalOptions.d.ts", "releaseTag": "Public", "name": "ElectronShellOpenExternalOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShellOpenExternalOptions#activate:member", "docComment": "/**\n * Whether to activate the opened application.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "activate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "activate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShellOpenExternalOptions#workingDirectory:member", "docComment": "/**\n * The working directory for the opened application.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workingDirectory?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "workingDirectory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronShortcutDetails:interface", "docComment": "/**\n * Details of a shortcut link used by `readShortcutLink` and `writeShortcutLink`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronShortcutDetails " } ], "fileUrlPath": "src/electron/internals/ElectronShortcutDetails.d.ts", "releaseTag": "Public", "name": "ElectronShortcutDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShortcutDetails#appUserModelId:member", "docComment": "/**\n * The Application User Model ID.\n *\n * @default\n *\n * `''`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appUserModelId?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "appUserModelId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShortcutDetails#args:member", "docComment": "/**\n * The arguments to be applied to `target` when launching from this shortcut.\n *\n * @default\n *\n * `''`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShortcutDetails#cwd:member", "docComment": "/**\n * The working directory.\n *\n * @default\n *\n * `''`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cwd?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cwd", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShortcutDetails#description:member", "docComment": "/**\n * The description of the shortcut.\n *\n * @default\n *\n * `''`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShortcutDetails#icon:member", "docComment": "/**\n * The path to the icon, can be a DLL or EXE. `icon` and `iconIndex` have to be set together. An empty value uses the target's icon.\n *\n * @default\n *\n * `''`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShortcutDetails#iconIndex:member", "docComment": "/**\n * The resource ID of icon when `icon` is a DLL or EXE.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "iconIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShortcutDetails#target:member", "docComment": "/**\n * The target to launch from this shortcut.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "target: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "target", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronShortcutDetails#toastActivatorClsid:member", "docComment": "/**\n * The Application Toast Activator CLSID. Needed for participating in Action Center.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toastActivatorClsid?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toastActivatorClsid", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSize:interface", "docComment": "/**\n * Represents dimensions with width and height.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSize " } ], "fileUrlPath": "src/electron/internals/ElectronSize.d.ts", "releaseTag": "Public", "name": "ElectronSize", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSize#height:member", "docComment": "/**\n * The height component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSize#width:member", "docComment": "/**\n * The width component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSourcesOptions:interface", "docComment": "/**\n * Options for `desktopCapturer.getSources`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSourcesOptions " } ], "fileUrlPath": "src/electron/internals/ElectronSourcesOptions.d.ts", "releaseTag": "Public", "name": "ElectronSourcesOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSourcesOptions#fetchWindowIcons:member", "docComment": "/**\n * Set to `true` to enable fetching window icons. When `false` the `appIcon` property of the sources returns `null`, as it does if a source has the type screen.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fetchWindowIcons?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fetchWindowIcons", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSourcesOptions#thumbnailSize:member", "docComment": "/**\n * The size that the media source thumbnail should be scaled to. Set width or height to `0` when thumbnails are not needed, to save the processing time required for capturing the content of each window and screen.\n *\n * @default\n *\n * `{ width: 150, height: 150 }`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "thumbnailSize?: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "thumbnailSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSourcesOptions#types:member", "docComment": "/**\n * An array of strings listing the types of desktop sources to be captured. Available types are `screen` and `window`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "types: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "types", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSSLConfigConfig:interface", "docComment": "/**\n * SSL configuration for a session.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSSLConfigConfig " } ], "fileUrlPath": "src/electron/internals/ElectronSSLConfigConfig.d.ts", "releaseTag": "Public", "name": "ElectronSSLConfigConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSSLConfigConfig#disabledCipherSuites:member", "docComment": "/**\n * List of cipher suites which should be explicitly prevented from being used, in addition to those disabled by the net built-in policy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disabledCipherSuites?: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disabledCipherSuites", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSSLConfigConfig#maxVersion:member", "docComment": "/**\n * The maximum SSL version to allow when connecting to remote servers. Can be `tls1.2` or `tls1.3`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxVersion?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxVersion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSSLConfigConfig#minVersion:member", "docComment": "/**\n * The minimum SSL version to allow when connecting to remote servers. Can be `tls1`, `tls1.1`, `tls1.2` or `tls1.3`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minVersion?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "minVersion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronStartLoggingOptions:interface", "docComment": "/**\n * Options controlling how network events are captured when logging starts.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronStartLoggingOptions " } ], "fileUrlPath": "src/electron/internals/ElectronStartLoggingOptions.d.ts", "releaseTag": "Public", "name": "ElectronStartLoggingOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronStartLoggingOptions#captureMode:member", "docComment": "/**\n * What kinds of data should be captured. `includeSensitive` adds cookies and auth data; `everything` adds all bytes transferred on sockets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "captureMode?: " }, { "kind": "Content", "text": "'default' | 'everything' | 'includeSensitive'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "captureMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronStartLoggingOptions#maxFileSize:member", "docComment": "/**\n * When the log grows beyond this size, logging will automatically stop.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxFileSize?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxFileSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronSystemPreferences:interface", "docComment": "/**\n * Electron SystemPreferences for reading and writing system-wide preferences.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronSystemPreferences " } ], "fileUrlPath": "src/electron/internals/ElectronSystemPreferences.d.ts", "releaseTag": "Public", "name": "ElectronSystemPreferences", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#addListener:member(1)", "docComment": "/**\n * Adds a listener for the `accent-color-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'accent-color-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newColor: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#addListener:member(2)", "docComment": "/**\n * Adds a listener for the `color-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'color-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#addListener:member(3)", "docComment": "/**\n * Adds a listener for the `high-contrast-color-scheme-changed` event.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'high-contrast-color-scheme-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", highContrastColorScheme: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#addListener:member(4)", "docComment": "/**\n * Adds a listener for the `inverted-color-scheme-changed` event.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'inverted-color-scheme-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", invertedColorScheme: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#appLevelAppearance:member", "docComment": "/**\n * A `string` property that can be `dark`, `light` or `unknown`. It determines the macOS appearance setting for your application. This maps to values in `NSApplication.appearance`. Setting this will override the system default as well as the value of `getEffectiveAppearance`.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appLevelAppearance: " }, { "kind": "Content", "text": "'dark' | 'light' | 'unknown'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "appLevelAppearance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#askForMediaAccess:member(1)", "docComment": "/**\n * Prompts the user for access to the given media type. Resolves with `true` if consent was granted and `false` if it was denied.\n *\n * @param mediaType - The media type to request access to.\n *\n * @returns A promise resolving to whether access was granted.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "askForMediaAccess(mediaType: " }, { "kind": "Content", "text": "'camera' | 'microphone'" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<boolean>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mediaType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "askForMediaAccess" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#canPromptTouchID:member(1)", "docComment": "/**\n * Returns whether or not this device has the ability to use Touch ID.\n *\n * @returns Whether this device can prompt for Touch ID.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canPromptTouchID(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canPromptTouchID" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#effectiveAppearance:member", "docComment": "/**\n * A `string` property that can be `dark`, `light` or `unknown`. Returns the macOS appearance setting that is currently applied to your application, maps to `NSApplication.effectiveAppearance`.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly effectiveAppearance: " }, { "kind": "Content", "text": "'dark' | 'light' | 'unknown'" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "effectiveAppearance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#getAccentColor:member(1)", "docComment": "/**\n * Returns the user's current system wide accent color preference in RGBA hexadecimal form.\n *\n * @returns The accent color in RGBA hexadecimal form.\n *\n * Platform: `win32,darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAccentColor(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAccentColor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#getAnimationSettings:member(1)", "docComment": "/**\n * Returns an object with the system animation settings.\n *\n * @returns The system animation settings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAnimationSettings(): " }, { "kind": "Reference", "text": "ElectronAnimationSettings", "canonicalReference": "obsidian-typings!ElectronAnimationSettings:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAnimationSettings" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#getAppLevelAppearance:member(1)", "docComment": "/**\n * Gets the macOS appearance setting that you have declared you want for your application, maps to `NSApplication.appearance`. Can be `dark`, `light` or `unknown`.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `darwin`.\n *\n * @returns The declared app-level appearance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAppLevelAppearance(): " }, { "kind": "Content", "text": "'dark' | 'light' | 'unknown'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAppLevelAppearance" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#getColor:member(1)", "docComment": "/**\n * Returns the system color setting in RGB hexadecimal form (`#ABCDEF`).\n *\n * @param color - The named system color to look up.\n *\n * @returns The system color in RGB hexadecimal form.\n *\n * Platform: `win32,darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getColor(\n color:\n " }, { "kind": "Content", "text": "| '3d-dark-shadow'\n | '3d-face'\n | '3d-highlight'\n | '3d-light'\n | '3d-shadow'\n | 'active-border'\n | 'active-caption-gradient'\n | 'active-caption'\n | 'alternate-selected-control-text'\n | 'app-workspace'\n | 'button-text'\n | 'caption-text'\n | 'control-background'\n | 'control-text'\n | 'control'\n | 'desktop'\n | 'disabled-control-text'\n | 'disabled-text'\n | 'find-highlight'\n | 'grid'\n | 'header-text'\n | 'highlight-text'\n | 'highlight'\n | 'hotlight'\n | 'inactive-border'\n | 'inactive-caption-gradient'\n | 'inactive-caption-text'\n | 'inactive-caption'\n | 'info-background'\n | 'info-text'\n | 'keyboard-focus-indicator'\n | 'label'\n | 'link'\n | 'menu-highlight'\n | 'menu-text'\n | 'menu'\n | 'menubar'\n | 'placeholder-text'\n | 'quaternary-label'\n | 'scrollbar'\n | 'scrubber-textured-background'\n | 'secondary-label'\n | 'selected-content-background'\n | 'selected-control-text'\n | 'selected-control'\n | 'selected-menu-item-text'\n | 'selected-text-background'\n | 'selected-text'\n | 'separator'\n | 'shadow'\n | 'tertiary-label'\n | 'text-background'\n | 'text'\n | 'under-page-background'\n | 'unemphasized-selected-content-background'\n | 'unemphasized-selected-text-background'\n | 'unemphasized-selected-text'\n | 'window-background'\n | 'window-frame-text'\n | 'window-frame'\n | 'window-text'\n | 'window'" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getColor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#getEffectiveAppearance:member(1)", "docComment": "/**\n * Gets the macOS appearance setting that is currently applied to your application, maps to `NSApplication.effectiveAppearance`. Can be `dark`, `light` or `unknown`.\n *\n * @returns The effective appearance.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEffectiveAppearance(): " }, { "kind": "Content", "text": "'dark' | 'light' | 'unknown'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getEffectiveAppearance" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#getMediaAccessStatus:member(1)", "docComment": "/**\n * Returns the access status for the given media type. Can be `not-determined`, `granted`, `denied`, `restricted` or `unknown`.\n *\n * @param mediaType - The media type to query.\n *\n * @returns The access status for the given media type.\n *\n * Platform: `win32,darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMediaAccessStatus(mediaType: " }, { "kind": "Content", "text": "'camera' | 'microphone' | 'screen'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "'denied' | 'granted' | 'not-determined' | 'restricted' | 'unknown'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mediaType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getMediaAccessStatus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#getSystemColor:member(1)", "docComment": "/**\n * Returns one of several standard system colors that automatically adapt to vibrancy and changes in accessibility settings. The standard system color is formatted as `#RRGGBBAA`.\n *\n * @param color - The named standard system color to look up.\n *\n * @returns The standard system color formatted as `#RRGGBBAA`.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSystemColor(color: " }, { "kind": "Content", "text": "'blue' | 'brown' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSystemColor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#getUserDefault:member(1)", "docComment": "/**\n * Returns the value of `key` in `NSUserDefaults`.\n *\n * @param key - The `NSUserDefaults` key to read.\n *\n * @param type - The type of the value stored under `key`.\n *\n * @returns The value of `key` in `NSUserDefaults`.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getUserDefault<Type extends " }, { "kind": "Content", "text": "keyof " }, { "kind": "Reference", "text": "ElectronUserDefaultTypes", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes:interface" }, { "kind": "Content", "text": ">(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "Type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronUserDefaultTypes", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes:interface" }, { "kind": "Content", "text": "[Type]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "Type", "constraintTokenRange": { "startIndex": 1, "endIndex": 3 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "getUserDefault" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#isAeroGlassEnabled:member(1)", "docComment": "/**\n * Returns `true` if DWM composition (Aero Glass) is enabled, and `false` otherwise.\n *\n * @returns Whether DWM composition is enabled.\n *\n * Platform: `win32`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAeroGlassEnabled(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isAeroGlassEnabled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#isDarkMode:member(1)", "docComment": "/**\n * Returns whether the system is in Dark Mode.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `darwin,win32`.\n *\n * @returns Whether the system is in Dark Mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDarkMode(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isDarkMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#isHighContrastColorScheme:member(1)", "docComment": "/**\n * Returns `true` if a high contrast theme is active, `false` otherwise.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `darwin,win32`.\n *\n * @returns Whether a high contrast theme is active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isHighContrastColorScheme(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isHighContrastColorScheme" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#isInvertedColorScheme:member(1)", "docComment": "/**\n * Returns `true` if an inverted color scheme (a high contrast color scheme with light text and dark backgrounds) is active, `false` otherwise.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @returns Whether an inverted color scheme is active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isInvertedColorScheme(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isInvertedColorScheme" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#isSwipeTrackingFromScrollEventsEnabled:member(1)", "docComment": "/**\n * Returns whether the Swipe between pages setting is on.\n *\n * @returns Whether the Swipe between pages setting is on.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isSwipeTrackingFromScrollEventsEnabled(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isSwipeTrackingFromScrollEventsEnabled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#isTrustedAccessibilityClient:member(1)", "docComment": "/**\n * Returns `true` if the current process is a trusted accessibility client and `false` if it is not.\n *\n * @param prompt - Whether to prompt the user with a system dialog if the process is not trusted.\n *\n * @returns Whether the current process is a trusted accessibility client.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isTrustedAccessibilityClient(prompt: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "prompt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isTrustedAccessibilityClient" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#on:member(1)", "docComment": "/**\n * Registers a listener for the `accent-color-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'accent-color-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newColor: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#on:member(2)", "docComment": "/**\n * Registers a listener for the `color-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'color-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#on:member(3)", "docComment": "/**\n * Registers a listener for the `high-contrast-color-scheme-changed` event.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'high-contrast-color-scheme-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", highContrastColorScheme: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#on:member(4)", "docComment": "/**\n * Registers a listener for the `inverted-color-scheme-changed` event.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'inverted-color-scheme-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", invertedColorScheme: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `accent-color-changed` event. The listener is removed after it is invoked once.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'accent-color-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newColor: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `color-changed` event. The listener is removed after it is invoked once.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'color-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#once:member(3)", "docComment": "/**\n * Registers a one-time listener for the `high-contrast-color-scheme-changed` event. The listener is removed after it is invoked once.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'high-contrast-color-scheme-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", highContrastColorScheme: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#once:member(4)", "docComment": "/**\n * Registers a one-time listener for the `inverted-color-scheme-changed` event. The listener is removed after it is invoked once.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'inverted-color-scheme-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", invertedColorScheme: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#postLocalNotification:member(1)", "docComment": "/**\n * Posts `event` as native notifications of macOS. The `userInfo` is an object that contains the user information dictionary sent along with the notification.\n *\n * @param event - The notification event name.\n *\n * @param userInfo - The user information dictionary sent along with the notification.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postLocalNotification(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userInfo: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userInfo", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "postLocalNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#postNotification:member(1)", "docComment": "/**\n * Posts `event` as native notifications of macOS. The `userInfo` is an object that contains the user information dictionary sent along with the notification.\n *\n * @param event - The notification event name.\n *\n * @param userInfo - The user information dictionary sent along with the notification.\n *\n * @param deliverImmediately - Whether to deliver the notification immediately.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postNotification(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userInfo: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ", deliverImmediately?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userInfo", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "deliverImmediately", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "postNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#postWorkspaceNotification:member(1)", "docComment": "/**\n * Posts `event` as native notifications of macOS. The `userInfo` is an object that contains the user information dictionary sent along with the notification.\n *\n * @param event - The notification event name.\n *\n * @param userInfo - The user information dictionary sent along with the notification.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postWorkspaceNotification(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userInfo: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userInfo", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "postWorkspaceNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#promptTouchID:member(1)", "docComment": "/**\n * Prompts the user to authenticate with Touch ID. Resolves if the user has successfully authenticated with Touch ID.\n *\n * @param reason - The reason presented to the user for the authentication request.\n *\n * @returns A promise that resolves once the user has authenticated.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promptTouchID(reason: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reason", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "promptTouchID" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#registerDefaults:member(1)", "docComment": "/**\n * Adds the specified defaults to your application's `NSUserDefaults`.\n *\n * @param defaults - The defaults to add.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerDefaults(defaults: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, boolean | number | string>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "defaults", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "registerDefaults" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#removeListener:member(1)", "docComment": "/**\n * Removes the specified listener for the `accent-color-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'accent-color-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", newColor: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#removeListener:member(2)", "docComment": "/**\n * Removes the specified listener for the `color-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'color-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#removeListener:member(3)", "docComment": "/**\n * Removes the specified listener for the `high-contrast-color-scheme-changed` event.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'high-contrast-color-scheme-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", highContrastColorScheme: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#removeListener:member(4)", "docComment": "/**\n * Removes the specified listener for the `inverted-color-scheme-changed` event.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `win32`.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This `ElectronSystemPreferences` instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'inverted-color-scheme-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", invertedColorScheme: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#removeUserDefault:member(1)", "docComment": "/**\n * Removes the `key` in `NSUserDefaults`. This can be used to restore the default or global value of a `key` previously set with `setUserDefault`.\n *\n * @param key - The `NSUserDefaults` key to remove.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeUserDefault(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeUserDefault" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#setAppLevelAppearance:member(1)", "docComment": "/**\n * Sets the appearance setting for your application, this should override the system default and override the value of `getEffectiveAppearance`.\n *\n * @deprecated\n *\n * Deprecated by Electron. Platform: `darwin`.\n *\n * @param appearance - The appearance to set, or `null` to reset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAppLevelAppearance(appearance: " }, { "kind": "Content", "text": "'dark' | 'light' | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "appearance", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setAppLevelAppearance" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#setUserDefault:member(1)", "docComment": "/**\n * Sets the value of `key` in `NSUserDefaults`. Note that `type` should match the actual type of `value`. An exception is thrown if they don't.\n *\n * @param key - The `NSUserDefaults` key to write.\n *\n * @param type - The type of the value being stored.\n *\n * @param value - The value to store.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUserDefault<Type extends " }, { "kind": "Content", "text": "keyof " }, { "kind": "Reference", "text": "ElectronUserDefaultTypes", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes:interface" }, { "kind": "Content", "text": ">(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "Type" }, { "kind": "Content", "text": ", value: " }, { "kind": "Reference", "text": "ElectronUserDefaultTypes", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes:interface" }, { "kind": "Content", "text": "[Type]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "Type", "constraintTokenRange": { "startIndex": 1, "endIndex": 3 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "setUserDefault" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#subscribeLocalNotification:member(1)", "docComment": "/**\n * Same as `subscribeNotification`, but uses `NSNotificationCenter` for local defaults. If `event` is `null`, the `NSNotificationCenter` doesn't use it as criteria for delivery to the observer.\n *\n * @param event - The notification event name, or `null`.\n *\n * @param callback - Called when the corresponding event happens.\n *\n * @returns The ID of this subscription.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subscribeLocalNotification(event: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(event: string, userInfo: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>, object: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "subscribeLocalNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#subscribeNotification:member(1)", "docComment": "/**\n * Subscribes to native notifications of macOS, `callback` will be called with `callback(event, userInfo)` when the corresponding `event` happens. If `event` is `null`, the `NSDistributedNotificationCenter` doesn't use it as criteria for delivery to the observer.\n *\n * @param event - The notification event name, or `null`.\n *\n * @param callback - Called when the corresponding event happens.\n *\n * @returns The ID of this subscription.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subscribeNotification(event: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(event: string, userInfo: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>, object: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "subscribeNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#subscribeWorkspaceNotification:member(1)", "docComment": "/**\n * Same as `subscribeNotification`, but uses `NSWorkspace.sharedWorkspace.notificationCenter`. If `event` is `null`, the `NSWorkspaceNotificationCenter` doesn't use it as criteria for delivery to the observer.\n *\n * @param event - The notification event name, or `null`.\n *\n * @param callback - Called when the corresponding event happens.\n *\n * @returns The ID of this subscription.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subscribeWorkspaceNotification(event: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(event: string, userInfo: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>, object: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "subscribeWorkspaceNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#unsubscribeLocalNotification:member(1)", "docComment": "/**\n * Same as `unsubscribeNotification`, but removes the subscriber from `NSNotificationCenter`.\n *\n * @param id - The ID of the subscription to remove.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unsubscribeLocalNotification(id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unsubscribeLocalNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#unsubscribeNotification:member(1)", "docComment": "/**\n * Removes the subscriber with `id`.\n *\n * @param id - The ID of the subscription to remove.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unsubscribeNotification(id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unsubscribeNotification" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronSystemPreferences#unsubscribeWorkspaceNotification:member(1)", "docComment": "/**\n * Same as `unsubscribeNotification`, but removes the subscriber from `NSWorkspace.sharedWorkspace.notificationCenter`.\n *\n * @param id - The ID of the subscription to remove.\n *\n * Platform: `darwin`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unsubscribeWorkspaceNotification(id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unsubscribeWorkspaceNotification" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTask:interface", "docComment": "/**\n * A task in the Tasks category of a Windows Jump List.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTask " } ], "fileUrlPath": "src/electron/internals/ElectronTask.d.ts", "releaseTag": "Public", "name": "ElectronTask", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTask#arguments:member", "docComment": "/**\n * The command line arguments when `program` is executed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "arguments: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "arguments", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTask#description:member", "docComment": "/**\n * Description of this task.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTask#iconIndex:member", "docComment": "/**\n * The icon index in the icon file. If an icon file consists of one icon, this value is `0`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "iconIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTask#iconPath:member", "docComment": "/**\n * The absolute path to an icon to be displayed in a Jump List.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "iconPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTask#program:member", "docComment": "/**\n * Path of the program to execute, usually `process.execPath`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "program: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "program", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTask#title:member", "docComment": "/**\n * The string to be displayed in a Jump List.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTask#workingDirectory:member", "docComment": "/**\n * The working directory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workingDirectory?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "workingDirectory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronThumbarButton:interface", "docComment": "/**\n * A button in a thumbnail toolbar (Windows only).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronThumbarButton " } ], "fileUrlPath": "src/electron/internals/ElectronThumbarButton.d.ts", "releaseTag": "Public", "name": "ElectronThumbarButton", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronThumbarButton#click:member(1)", "docComment": "/**\n * Callback invoked when the button is clicked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "click(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "click" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronThumbarButton#flags:member", "docComment": "/**\n * Control specific states and behaviors of the button.\n *\n * @default\n *\n * `['enabled']`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "flags?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "flags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronThumbarButton#icon:member", "docComment": "/**\n * The icon showing in the thumbnail toolbar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronThumbarButton#tooltip:member", "docComment": "/**\n * The text of the button's tooltip.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tooltip?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tooltip", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlay:interface", "docComment": "/**\n * Configuration for the Window Controls Overlay when creating a window.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTitleBarOverlay " } ], "fileUrlPath": "src/electron/internals/ElectronTitleBarOverlay.d.ts", "releaseTag": "Public", "name": "ElectronTitleBarOverlay", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlay#color:member", "docComment": "/**\n * The CSS color of the Window Controls Overlay when enabled (Windows only). Default is the system color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlay#height:member", "docComment": "/**\n * The height of the title bar and Window Controls Overlay in pixels (macOS and Windows). Default is the system height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlay#symbolColor:member", "docComment": "/**\n * The CSS color of the symbols on the Window Controls Overlay when enabled (Windows only). Default is the system color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "symbolColor?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "symbolColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlayOptions:interface", "docComment": "/**\n * Options for {@link ElectronBrowserWindow.setTitleBarOverlay}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTitleBarOverlayOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTitleBarOverlayOptions.d.ts", "releaseTag": "Public", "name": "ElectronTitleBarOverlayOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlayOptions#color:member", "docComment": "/**\n * The CSS color of the Window Controls Overlay when enabled (Windows only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlayOptions#height:member", "docComment": "/**\n * The height of the title bar and Window Controls Overlay in pixels (Windows only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTitleBarOverlayOptions#symbolColor:member", "docComment": "/**\n * The CSS color of the symbols on the Window Controls Overlay when enabled (Windows only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "symbolColor?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "symbolColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTitleOptions:interface", "docComment": "/**\n * Options for {@link ElectronTray.setTitle}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTitleOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTitleOptions.d.ts", "releaseTag": "Public", "name": "ElectronTitleOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTitleOptions#fontType:member", "docComment": "/**\n * The font family variant to display, can be `monospaced` or `monospacedDigit`. `monospaced` is available in macOS 10.15+ and `monospacedDigit` is available in macOS 10.11+. When left blank, the title uses the default system font.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontType?: " }, { "kind": "Content", "text": "'monospaced' | 'monospacedDigit'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fontType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBar:class", "docComment": "/**\n * Electron TouchBar for building a macOS Touch Bar layout.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBar " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBar.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBar", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBar:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBar}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar#escapeItem:member", "docComment": "/**\n * The item that replaces the \"esc\" button on the touch bar. Setting to `null` restores the default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "escapeItem: " }, { "kind": "Reference", "text": "ElectronTouchBarButton", "canonicalReference": "obsidian-typings!ElectronTouchBarButton:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarColorPicker", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPicker:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarGroup", "canonicalReference": "obsidian-typings!ElectronTouchBarGroup:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarLabel", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarPopover", "canonicalReference": "obsidian-typings!ElectronTouchBarPopover:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarScrubber", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSegmentedControl", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSlider", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSpacer", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacer:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "escapeItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 19 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarButton:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarButton} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarButton: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarButton", "canonicalReference": "obsidian-typings!ElectronTouchBarButton:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarButton", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarColorPicker:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarColorPicker} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarColorPicker: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarColorPicker", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPicker:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarColorPicker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarGroup:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarGroup} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarGroup: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarGroup", "canonicalReference": "obsidian-typings!ElectronTouchBarGroup:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarGroup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarLabel:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarLabel} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarLabel: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarLabel", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarOtherItemsProxy:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarOtherItemsProxy} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarOtherItemsProxy: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarOtherItemsProxy", "canonicalReference": "obsidian-typings!ElectronTouchBarOtherItemsProxy:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarOtherItemsProxy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarPopover:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarPopover} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarPopover: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarPopover", "canonicalReference": "obsidian-typings!ElectronTouchBarPopover:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarPopover", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarScrubber:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarScrubber} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarScrubber: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarScrubber", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarScrubber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarSegmentedControl:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarSegmentedControl} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarSegmentedControl: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarSegmentedControl", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarSegmentedControl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarSlider:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarSlider} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarSlider: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarSlider", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarSlider", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBar.TouchBarSpacer:member", "docComment": "/**\n * Reference to the {@link ElectronTouchBarSpacer} class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static TouchBarSpacer: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ElectronTouchBarSpacer", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacer:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TouchBarSpacer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarButton:class", "docComment": "/**\n * A button item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarButton " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarButton.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarButton", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarButton:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarButton}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarButtonConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarButton#accessibilityLabel:member", "docComment": "/**\n * Description of the button to be read by a screen reader. Read only if no label is set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accessibilityLabel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "accessibilityLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarButton#backgroundColor:member", "docComment": "/**\n * Hex code representing the button's current background color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundColor: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backgroundColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarButton#enabled:member", "docComment": "/**\n * Whether the button is in an enabled state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarButton#icon:member", "docComment": "/**\n * The button's current icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarButton#iconPosition:member", "docComment": "/**\n * The position of the icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconPosition: " }, { "kind": "Content", "text": "'left' | 'overlay' | 'right'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "iconPosition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarButton#label:member", "docComment": "/**\n * The button's current text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarButton}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarButtonConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarButtonConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarButtonConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions#accessibilityLabel:member", "docComment": "/**\n * A short description of the button for use by screen readers like VoiceOver.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accessibilityLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "accessibilityLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions#backgroundColor:member", "docComment": "/**\n * Button background color in hex format, i.e `#ABCDEF`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundColor?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "backgroundColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions#click:member(1)", "docComment": "/**\n * Callback invoked when the button is clicked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "click?(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "click" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions#enabled:member", "docComment": "/**\n * Whether the button is in an enabled state.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions#icon:member", "docComment": "/**\n * Button icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions#iconPosition:member", "docComment": "/**\n * Position of the icon.\n *\n * @default\n *\n * `overlay`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconPosition?: " }, { "kind": "Content", "text": "'left' | 'overlay' | 'right'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "iconPosition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarButtonConstructorOptions#label:member", "docComment": "/**\n * Button text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPicker:class", "docComment": "/**\n * A color picker item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarColorPicker " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarColorPicker.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarColorPicker", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPicker:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarColorPicker}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarColorPickerConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPickerConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPicker#availableColors:member", "docComment": "/**\n * The color picker's available colors to select.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "availableColors: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "availableColors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPicker#selectedColor:member", "docComment": "/**\n * Hex code representing the color picker's currently selected color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedColor: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectedColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPickerConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarColorPicker}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarColorPickerConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarColorPickerConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarColorPickerConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPickerConstructorOptions#availableColors:member", "docComment": "/**\n * Array of hex color strings to appear as possible colors to select.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "availableColors?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "availableColors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPickerConstructorOptions#change:member(1)", "docComment": "/**\n * Callback invoked when a color is selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "change?(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "change" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPickerConstructorOptions#selectedColor:member", "docComment": "/**\n * The selected hex color in the picker, i.e `#ABCDEF`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedColor?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selectedColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarConstructorOptions#escapeItem:member", "docComment": "/**\n * The item that will replace the \"esc\" button on the touch bar when set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "escapeItem?: " }, { "kind": "Reference", "text": "ElectronTouchBarButton", "canonicalReference": "obsidian-typings!ElectronTouchBarButton:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarColorPicker", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPicker:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarGroup", "canonicalReference": "obsidian-typings!ElectronTouchBarGroup:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarLabel", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarPopover", "canonicalReference": "obsidian-typings!ElectronTouchBarPopover:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarScrubber", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSegmentedControl", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSlider", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSpacer", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacer:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "escapeItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 19 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarConstructorOptions#items:member", "docComment": "/**\n * The items to display in the touch bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items?: " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ElectronTouchBarButton", "canonicalReference": "obsidian-typings!ElectronTouchBarButton:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarColorPicker", "canonicalReference": "obsidian-typings!ElectronTouchBarColorPicker:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarGroup", "canonicalReference": "obsidian-typings!ElectronTouchBarGroup:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarLabel", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarPopover", "canonicalReference": "obsidian-typings!ElectronTouchBarPopover:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarScrubber", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSegmentedControl", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSlider", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronTouchBarSpacer", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacer:class" }, { "kind": "Content", "text": ")[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 20 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarGroup:class", "docComment": "/**\n * A group item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarGroup " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarGroup.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarGroup", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarGroup:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarGroup}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarGroupConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarGroupConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarGroupConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarGroup}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarGroupConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarGroupConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarGroupConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarGroupConstructorOptions#items:member", "docComment": "/**\n * Items to display as a group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "ElectronTouchBar", "canonicalReference": "obsidian-typings!ElectronTouchBar:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel:class", "docComment": "/**\n * A label item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarLabel " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarLabel.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarLabel", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarLabel}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarLabelConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarLabelConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel#accessibilityLabel:member", "docComment": "/**\n * Description of the label to be read by a screen reader.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accessibilityLabel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "accessibilityLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel#label:member", "docComment": "/**\n * The label's current text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarLabel#textColor:member", "docComment": "/**\n * Hex code representing the label's current text color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textColor: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "textColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarLabelConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarLabel}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarLabelConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarLabelConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarLabelConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarLabelConstructorOptions#accessibilityLabel:member", "docComment": "/**\n * A short description of the label for use by screen readers like VoiceOver.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accessibilityLabel?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "accessibilityLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarLabelConstructorOptions#label:member", "docComment": "/**\n * Text to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarLabelConstructorOptions#textColor:member", "docComment": "/**\n * Hex color of text, i.e `#ABCDEF`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textColor?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "textColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarOtherItemsProxy:class", "docComment": "/**\n * A proxy item that reserves space for system-provided items in a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarOtherItemsProxy " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarOtherItemsProxy.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarOtherItemsProxy", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarOtherItemsProxy:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarOtherItemsProxy}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor();" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [] } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarPopover:class", "docComment": "/**\n * A popover item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarPopover " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarPopover.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarPopover", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarPopover:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarPopover}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarPopoverConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarPopoverConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarPopover#icon:member", "docComment": "/**\n * The popover's current button icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarPopover#label:member", "docComment": "/**\n * The popover's current button text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarPopoverConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarPopover}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarPopoverConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarPopoverConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarPopoverConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarPopoverConstructorOptions#icon:member", "docComment": "/**\n * Popover button icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarPopoverConstructorOptions#items:member", "docComment": "/**\n * Items to display in the popover.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "ElectronTouchBar", "canonicalReference": "obsidian-typings!ElectronTouchBar:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarPopoverConstructorOptions#label:member", "docComment": "/**\n * Popover button text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarPopoverConstructorOptions#showCloseButton:member", "docComment": "/**\n * Whether to display a close button on the left of the popover.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showCloseButton?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showCloseButton", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber:class", "docComment": "/**\n * A scrubber item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarScrubber " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarScrubber.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarScrubber", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarScrubber}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarScrubberConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber#continuous:member", "docComment": "/**\n * Whether this scrubber is continuous.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "continuous: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "continuous", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber#items:member", "docComment": "/**\n * The items in this scrubber.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "ElectronScrubberItem", "canonicalReference": "obsidian-typings!ElectronScrubberItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber#mode:member", "docComment": "/**\n * The mode of this scrubber.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode: " }, { "kind": "Content", "text": "'fixed' | 'free'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber#overlayStyle:member", "docComment": "/**\n * The style that selected items in the scrubber should have, overlaid on top of the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overlayStyle: " }, { "kind": "Content", "text": "'background' | 'none' | 'outline'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "overlayStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber#selectedStyle:member", "docComment": "/**\n * The style that selected items in the scrubber should have.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedStyle: " }, { "kind": "Content", "text": "'background' | 'none' | 'outline'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectedStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubber#showArrowButtons:member", "docComment": "/**\n * Whether to show the left / right selection arrows in this scrubber.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showArrowButtons: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showArrowButtons", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarScrubber}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarScrubberConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarScrubberConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarScrubberConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions#continuous:member", "docComment": "/**\n * Whether this scrubber is continuous.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "continuous?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "continuous", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions#highlight:member(1)", "docComment": "/**\n * Callback invoked when the user taps any item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlight?(highlightedIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "highlightedIndex", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "highlight" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions#items:member", "docComment": "/**\n * An array of items to place in this scrubber.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "ElectronScrubberItem", "canonicalReference": "obsidian-typings!ElectronScrubberItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions#mode:member", "docComment": "/**\n * The mode of this scrubber.\n *\n * @default\n *\n * `free`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode?: " }, { "kind": "Content", "text": "'fixed' | 'free'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions#overlayStyle:member", "docComment": "/**\n * Selected overlay item style.\n *\n * @default\n *\n * `none`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overlayStyle?: " }, { "kind": "Content", "text": "'background' | 'none' | 'outline'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "overlayStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions#select:member(1)", "docComment": "/**\n * Callback invoked when the user taps an item that was not the last tapped item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "select?(selectedIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "selectedIndex", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "select" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions#selectedStyle:member", "docComment": "/**\n * Selected item style.\n *\n * @default\n *\n * `none`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedStyle?: " }, { "kind": "Content", "text": "'background' | 'none' | 'outline'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selectedStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarScrubberConstructorOptions#showArrowButtons:member", "docComment": "/**\n * Whether to show arrow buttons. Only shown if `items` is non-empty.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showArrowButtons?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showArrowButtons", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl:class", "docComment": "/**\n * A segmented control item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarSegmentedControl " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarSegmentedControl.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarSegmentedControl", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarSegmentedControl}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarSegmentedControlConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControlConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl#mode:member", "docComment": "/**\n * The current selection mode of the control.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode: " }, { "kind": "Content", "text": "'buttons' | 'multiple' | 'single'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl#segments:member", "docComment": "/**\n * The segments in this control.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "segments: " }, { "kind": "Reference", "text": "ElectronSegmentedControlSegment", "canonicalReference": "obsidian-typings!ElectronSegmentedControlSegment:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "segments", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl#segmentStyle:member", "docComment": "/**\n * The control's current segment style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "segmentStyle: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "segmentStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControl#selectedIndex:member", "docComment": "/**\n * The currently selected segment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectedIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControlConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarSegmentedControl}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarSegmentedControlConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarSegmentedControlConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarSegmentedControlConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControlConstructorOptions#change:member(1)", "docComment": "/**\n * Callback invoked when the user selects a new segment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "change?(selectedIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", isSelected: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "selectedIndex", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "isSelected", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "change" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControlConstructorOptions#mode:member", "docComment": "/**\n * The selection mode of the control.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode?: " }, { "kind": "Content", "text": "'buttons' | 'multiple' | 'single'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControlConstructorOptions#segments:member", "docComment": "/**\n * An array of segments to place in this control.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "segments: " }, { "kind": "Reference", "text": "ElectronSegmentedControlSegment", "canonicalReference": "obsidian-typings!ElectronSegmentedControlSegment:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "segments", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControlConstructorOptions#segmentStyle:member", "docComment": "/**\n * Style of the segments.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "segmentStyle?: " }, { "kind": "Content", "text": "'automatic' | 'capsule' | 'round-rect' | 'rounded' | 'separated' | 'small-square' | 'textured-rounded' | 'textured-square'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "segmentStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSegmentedControlConstructorOptions#selectedIndex:member", "docComment": "/**\n * The index of the currently selected segment, updated automatically with user interaction. When the mode is `multiple` it will be the last selected item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selectedIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider:class", "docComment": "/**\n * A slider item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarSlider " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarSlider.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarSlider", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarSlider}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarSliderConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarSliderConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider#label:member", "docComment": "/**\n * The slider's current text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider#maxValue:member", "docComment": "/**\n * The slider's current maximum value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxValue: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "maxValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider#minValue:member", "docComment": "/**\n * The slider's current minimum value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minValue: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSlider#value:member", "docComment": "/**\n * The slider's current value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarSliderConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarSlider}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarSliderConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarSliderConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarSliderConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSliderConstructorOptions#change:member(1)", "docComment": "/**\n * Callback invoked when the slider is changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "change?(newValue: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "newValue", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "change" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSliderConstructorOptions#label:member", "docComment": "/**\n * Label text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSliderConstructorOptions#maxValue:member", "docComment": "/**\n * Maximum value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxValue?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSliderConstructorOptions#minValue:member", "docComment": "/**\n * Minimum value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minValue?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "minValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSliderConstructorOptions#value:member", "docComment": "/**\n * Selected value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacer:class", "docComment": "/**\n * A spacer item for a {@link ElectronTouchBar}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTouchBarSpacer " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarSpacer.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTouchBarSpacer", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacer:constructor(1)", "docComment": "/**\n * Create new instance of {@link ElectronTouchBarSpacer}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "ElectronTouchBarSpacerConstructorOptions", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacerConstructorOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacer#size:member", "docComment": "/**\n * The size of the spacer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size: " }, { "kind": "Content", "text": "'flexible' | 'large' | 'small'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "size", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacerConstructorOptions:interface", "docComment": "/**\n * Options for creating a {@link ElectronTouchBarSpacer}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTouchBarSpacerConstructorOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTouchBarSpacerConstructorOptions.d.ts", "releaseTag": "Public", "name": "ElectronTouchBarSpacerConstructorOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTouchBarSpacerConstructorOptions#size:member", "docComment": "/**\n * Size of the spacer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size?: " }, { "kind": "Content", "text": "'flexible' | 'large' | 'small'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "size", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTraceBufferUsageReturnValue:interface", "docComment": "/**\n * The maximum usage across processes of the trace buffer.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTraceBufferUsageReturnValue " } ], "fileUrlPath": "src/electron/internals/ElectronTraceBufferUsageReturnValue.d.ts", "releaseTag": "Public", "name": "ElectronTraceBufferUsageReturnValue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceBufferUsageReturnValue#percentage:member", "docComment": "/**\n * The percentage of the trace buffer maximum usage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "percentage: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "percentage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceBufferUsageReturnValue#value:member", "docComment": "/**\n * The value of the trace buffer maximum usage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTraceCategoriesAndOptions:interface", "docComment": "/**\n * Legacy trace configuration controlling which category groups are traced and how.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTraceCategoriesAndOptions " } ], "fileUrlPath": "src/electron/internals/ElectronTraceCategoriesAndOptions.d.ts", "releaseTag": "Public", "name": "ElectronTraceCategoriesAndOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceCategoriesAndOptions#categoryFilter:member", "docComment": "/**\n * A filter to control what category groups should be traced. A filter can have an optional `-` prefix to exclude category groups that contain a matching category. Having both included and excluded category patterns in the same list is not supported. Examples: `test_MyTest*`, `test_MyTest*,test_OtherStuff`, `-excluded_category1,-excluded_category2`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "categoryFilter: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "categoryFilter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceCategoriesAndOptions#traceOptions:member", "docComment": "/**\n * Controls what kind of tracing is enabled. It is a comma-delimited sequence of the following strings: `record-until-full`, `record-continuously`, `trace-to-console`, `enable-sampling`, `enable-systrace`, e.g. `'record-until-full,enable-sampling'`. The first 3 options are trace recording modes and hence mutually exclusive. If more than one trace recording mode appears in the `traceOptions` string, the last one takes precedence. If none of the trace recording modes are specified, recording mode is `record-until-full`. The trace option will first be reset to the default option (`record_mode` set to `record-until-full`, `enable_sampling` and `enable_systrace` set to `false`) before options parsed from `traceOptions` are applied on it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "traceOptions: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "traceOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTraceConfig:interface", "docComment": "/**\n * Trace configuration controlling which categories are traced and how the recording behaves.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTraceConfig " } ], "fileUrlPath": "src/electron/internals/ElectronTraceConfig.d.ts", "releaseTag": "Public", "name": "ElectronTraceConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#enable_argument_filter:member", "docComment": "/**\n * If `true`, filter event data according to a specific list of events that have been manually vetted to not include any PII. See the implementation in Chromium for specifics.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enable_argument_filter?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enable_argument_filter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#excluded_categories:member", "docComment": "/**\n * A list of tracing categories to exclude. Can include glob-like patterns using `*` at the end of the category name. See tracing categories for the list of categories.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "excluded_categories?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "excluded_categories", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#histogram_names:member", "docComment": "/**\n * A list of histogram names to report with the trace.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "histogram_names?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "histogram_names", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#included_categories:member", "docComment": "/**\n * A list of tracing categories to include. Can include glob-like patterns using `*` at the end of the category name. See tracing categories for the list of categories.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "included_categories?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "included_categories", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#included_process_ids:member", "docComment": "/**\n * A list of process IDs to include in the trace. If not specified, trace all processes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "included_process_ids?: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "included_process_ids", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#memory_dump_config:member", "docComment": "/**\n * If the `disabled-by-default-memory-infra` category is enabled, this contains optional additional configuration for data collection. See the Chromium memory-infra docs for more information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "memory_dump_config?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "memory_dump_config", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#recording_mode:member", "docComment": "/**\n * Can be `record-as-much-as-possible`, `record-continuously`, `record-until-full` or `trace-to-console`.\n *\n * @default\n *\n * `record-until-full`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "recording_mode?: " }, { "kind": "Content", "text": "'record-as-much-as-possible' | 'record-continuously' | 'record-until-full' | 'trace-to-console'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "recording_mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#trace_buffer_size_in_events:member", "docComment": "/**\n * Maximum size of the trace recording buffer in events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trace_buffer_size_in_events?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "trace_buffer_size_in_events", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTraceConfig#trace_buffer_size_in_kb:member", "docComment": "/**\n * Maximum size of the trace recording buffer in kilobytes. Defaults to 100MB.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trace_buffer_size_in_kb?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "trace_buffer_size_in_kb", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronTransaction:interface", "docComment": "/**\n * A transaction in the Mac App Store payment queue.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronTransaction " } ], "fileUrlPath": "src/electron/internals/ElectronTransaction.d.ts", "releaseTag": "Public", "name": "ElectronTransaction", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTransaction#errorCode:member", "docComment": "/**\n * The error code if an error occurred while processing the transaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "errorCode: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "errorCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTransaction#errorMessage:member", "docComment": "/**\n * The error message if an error occurred while processing the transaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "errorMessage: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "errorMessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTransaction#originalTransactionIdentifier:member", "docComment": "/**\n * The identifier of the restored transaction by the App Store.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "originalTransactionIdentifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "originalTransactionIdentifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTransaction#payment:member", "docComment": "/**\n * The payment associated with the transaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "payment: " }, { "kind": "Reference", "text": "ElectronPayment", "canonicalReference": "obsidian-typings!ElectronPayment:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "payment", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTransaction#transactionDate:member", "docComment": "/**\n * The date the transaction was added to the App Store's payment queue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transactionDate: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "transactionDate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTransaction#transactionIdentifier:member", "docComment": "/**\n * A string that uniquely identifies a successful payment transaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transactionIdentifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "transactionIdentifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronTransaction#transactionState:member", "docComment": "/**\n * The transaction state. Can be `deferred`, `failed`, `purchased`, `purchasing` or `restored`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transactionState: " }, { "kind": "Content", "text": "'deferred' | 'failed' | 'purchased' | 'purchasing' | 'restored'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "transactionState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ElectronTray:class", "docComment": "/**\n * Electron Tray for adding icons and context menus to the system's notification area.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElectronTray " } ], "fileUrlPath": "src/electron/internals/ElectronTray.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElectronTray", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!ElectronTray:constructor(1)", "docComment": "/**\n * Create a new instance of {@link ElectronTray}.\n *\n * @param image - The image to use as the tray icon.\n *\n * @param guid - Assigns a GUID to the tray icon. `win32` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", guid?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "image", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "guid", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(1)", "docComment": "/**\n * Registers an event listener that is invoked when the tray balloon is clicked. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'balloon-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(10)", "docComment": "/**\n * Registers an event listener that is invoked when dragged files are dropped in the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the paths of the dropped files.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'drop-files'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", files: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(11)", "docComment": "/**\n * Registers an event listener that is invoked when dragged text is dropped in the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the dropped text string.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'drop-text'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", text: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(12)", "docComment": "/**\n * Registers an event listener that is invoked when the mouse clicks the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'mouse-down'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(13)", "docComment": "/**\n * Registers an event listener that is invoked when the mouse enters the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'mouse-enter'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(14)", "docComment": "/**\n * Registers an event listener that is invoked when the mouse exits the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'mouse-leave'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(15)", "docComment": "/**\n * Registers an event listener that is invoked when the mouse moves in the tray icon. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'mouse-move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(16)", "docComment": "/**\n * Registers an event listener that is invoked when the mouse is released from clicking the tray icon.\n *\n * Note: This will not be emitted if you have set a context menu for your tray using {@link ElectronTray.setContextMenu}, as a result of macOS-level constraints. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'mouse-up'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(17)", "docComment": "/**\n * Registers an event listener that is invoked when the tray icon is right clicked. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the bounds of the tray icon.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'right-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(2)", "docComment": "/**\n * Registers an event listener that is invoked when the tray balloon is closed because of timeout or user manually closes it. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'balloon-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(3)", "docComment": "/**\n * Registers an event listener that is invoked when the tray balloon shows. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'balloon-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(4)", "docComment": "/**\n * Registers an event listener that is invoked when the tray icon is clicked.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event, the bounds of the tray icon, and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(5)", "docComment": "/**\n * Registers an event listener that is invoked when the tray icon is double clicked. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the bounds of the tray icon.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'double-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(6)", "docComment": "/**\n * Registers an event listener that is invoked when a drag operation ends on the tray or ends at another location. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'drag-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(7)", "docComment": "/**\n * Registers an event listener that is invoked when a drag operation enters the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'drag-enter'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(8)", "docComment": "/**\n * Registers an event listener that is invoked when a drag operation exits the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'drag-leave'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#addListener:member(9)", "docComment": "/**\n * Registers an event listener that is invoked when any dragged items are dropped on the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'drop'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#closeContextMenu:member(1)", "docComment": "/**\n * Closes an open context menu, as set by {@link ElectronTray.setContextMenu}. `darwin` and `win32` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeContextMenu(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "closeContextMenu" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#destroy:member(1)", "docComment": "/**\n * Destroys the tray icon immediately.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#displayBalloon:member(1)", "docComment": "/**\n * Displays a tray balloon. `win32` only.\n *\n * @param options - Options describing the balloon to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayBalloon(options: " }, { "kind": "Reference", "text": "ElectronDisplayBalloonOptions", "canonicalReference": "obsidian-typings!ElectronDisplayBalloonOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "displayBalloon" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#focus:member(1)", "docComment": "/**\n * Returns focus to the taskbar notification area. Notification area icons should use this message when they have completed their UI operation. For example, if the icon displays a shortcut menu, but the user presses ESC to cancel it, use `tray.focus()` to return focus to the notification area. `win32` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "focus" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#getBounds:member(1)", "docComment": "/**\n * The `bounds` of this tray icon. `darwin` and `win32` only.\n *\n * @returns The bounds of this tray icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBounds(): " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getBounds" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#getIgnoreDoubleClickEvents:member(1)", "docComment": "/**\n * Whether double click events will be ignored. `darwin` only.\n *\n * @returns `true` if double click events are ignored.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getIgnoreDoubleClickEvents(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getIgnoreDoubleClickEvents" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#getTitle:member(1)", "docComment": "/**\n * The title displayed next to the tray icon in the status bar. `darwin` only.\n *\n * @returns The title displayed next to the tray icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTitle(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getTitle" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#isDestroyed:member(1)", "docComment": "/**\n * Whether the tray icon is destroyed.\n *\n * @returns `true` if the tray icon is destroyed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDestroyed(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isDestroyed" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(1)", "docComment": "/**\n * Registers a listener that is invoked when the tray balloon is clicked. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'balloon-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(10)", "docComment": "/**\n * Registers a listener that is invoked when dragged files are dropped in the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the paths of the dropped files.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'drop-files'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", files: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(11)", "docComment": "/**\n * Registers a listener that is invoked when dragged text is dropped in the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the dropped text string.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'drop-text'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", text: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(12)", "docComment": "/**\n * Registers a listener that is invoked when the mouse clicks the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'mouse-down'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(13)", "docComment": "/**\n * Registers a listener that is invoked when the mouse enters the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'mouse-enter'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(14)", "docComment": "/**\n * Registers a listener that is invoked when the mouse exits the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'mouse-leave'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(15)", "docComment": "/**\n * Registers a listener that is invoked when the mouse moves in the tray icon. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'mouse-move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(16)", "docComment": "/**\n * Registers a listener that is invoked when the mouse is released from clicking the tray icon.\n *\n * Note: This will not be emitted if you have set a context menu for your tray using {@link ElectronTray.setContextMenu}, as a result of macOS-level constraints. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'mouse-up'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(17)", "docComment": "/**\n * Registers a listener that is invoked when the tray icon is right clicked. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the bounds of the tray icon.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'right-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(2)", "docComment": "/**\n * Registers a listener that is invoked when the tray balloon is closed because of timeout or user manually closes it. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'balloon-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(3)", "docComment": "/**\n * Registers a listener that is invoked when the tray balloon shows. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'balloon-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(4)", "docComment": "/**\n * Registers a listener that is invoked when the tray icon is clicked.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event, the bounds of the tray icon, and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(5)", "docComment": "/**\n * Registers a listener that is invoked when the tray icon is double clicked. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the bounds of the tray icon.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'double-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(6)", "docComment": "/**\n * Registers a listener that is invoked when a drag operation ends on the tray or ends at another location. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'drag-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(7)", "docComment": "/**\n * Registers a listener that is invoked when a drag operation enters the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'drag-enter'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(8)", "docComment": "/**\n * Registers a listener that is invoked when a drag operation exits the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'drag-leave'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#on:member(9)", "docComment": "/**\n * Registers a listener that is invoked when any dragged items are dropped on the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'drop'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "on" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(1)", "docComment": "/**\n * Registers a one-time listener that is invoked when the tray balloon is clicked. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'balloon-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(10)", "docComment": "/**\n * Registers a one-time listener that is invoked when dragged files are dropped in the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the paths of the dropped files.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'drop-files'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", files: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(11)", "docComment": "/**\n * Registers a one-time listener that is invoked when dragged text is dropped in the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the dropped text string.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'drop-text'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", text: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(12)", "docComment": "/**\n * Registers a one-time listener that is invoked when the mouse clicks the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'mouse-down'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(13)", "docComment": "/**\n * Registers a one-time listener that is invoked when the mouse enters the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'mouse-enter'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(14)", "docComment": "/**\n * Registers a one-time listener that is invoked when the mouse exits the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'mouse-leave'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(15)", "docComment": "/**\n * Registers a one-time listener that is invoked when the mouse moves in the tray icon. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'mouse-move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(16)", "docComment": "/**\n * Registers a one-time listener that is invoked when the mouse is released from clicking the tray icon.\n *\n * Note: This will not be emitted if you have set a context menu for your tray using {@link ElectronTray.setContextMenu}, as a result of macOS-level constraints. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'mouse-up'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(17)", "docComment": "/**\n * Registers a one-time listener that is invoked when the tray icon is right clicked. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the bounds of the tray icon.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'right-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(2)", "docComment": "/**\n * Registers a one-time listener that is invoked when the tray balloon is closed because of timeout or user manually closes it. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'balloon-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(3)", "docComment": "/**\n * Registers a one-time listener that is invoked when the tray balloon shows. `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'balloon-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(4)", "docComment": "/**\n * Registers a one-time listener that is invoked when the tray icon is clicked.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event, the bounds of the tray icon, and the position of the event.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(5)", "docComment": "/**\n * Registers a one-time listener that is invoked when the tray icon is double clicked. `darwin` and `win32` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler receiving the event and the bounds of the tray icon.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'double-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(6)", "docComment": "/**\n * Registers a one-time listener that is invoked when a drag operation ends on the tray or ends at another location. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'drag-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(7)", "docComment": "/**\n * Registers a one-time listener that is invoked when a drag operation enters the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'drag-enter'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(8)", "docComment": "/**\n * Registers a one-time listener that is invoked when a drag operation exits the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'drag-leave'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#once:member(9)", "docComment": "/**\n * Registers a one-time listener that is invoked when any dragged items are dropped on the tray icon. `darwin` only.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'drop'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "once" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#popUpContextMenu:member(1)", "docComment": "/**\n * Pops up the context menu of the tray icon. When `menu` is passed, the `menu` will be shown instead of the tray icon's context menu.\n *\n * The `position` is only available on Windows, and it is (0, 0) by default. `darwin` and `win32` only.\n *\n * @param menu - The menu to show instead of the tray icon's context menu.\n *\n * @param position - The position at which to pop up the menu.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "popUpContextMenu(menu?: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": ", position?: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "position", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "popUpContextMenu" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeBalloon:member(1)", "docComment": "/**\n * Removes a tray balloon. `win32` only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeBalloon(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "removeBalloon" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(1)", "docComment": "/**\n * Removes the event listener for the tray balloon being clicked.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'balloon-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(10)", "docComment": "/**\n * Removes the event listener for dragged files being dropped in the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'drop-files'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", files: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(11)", "docComment": "/**\n * Removes the event listener for dragged text being dropped in the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'drop-text'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", text: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(12)", "docComment": "/**\n * Removes the event listener for the mouse clicking the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'mouse-down'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(13)", "docComment": "/**\n * Removes the event listener for the mouse entering the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'mouse-enter'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(14)", "docComment": "/**\n * Removes the event listener for the mouse exiting the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'mouse-leave'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(15)", "docComment": "/**\n * Removes the event listener for the mouse moving in the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'mouse-move'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(16)", "docComment": "/**\n * Removes the event listener for the mouse being released from clicking the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'mouse-up'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(17)", "docComment": "/**\n * Removes the event listener for the tray icon being right clicked.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'right-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(2)", "docComment": "/**\n * Removes the event listener for the tray balloon being closed.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'balloon-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(3)", "docComment": "/**\n * Removes the event listener for the tray balloon being shown.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'balloon-show'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(4)", "docComment": "/**\n * Removes the event listener for the tray icon being clicked.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", position: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(5)", "docComment": "/**\n * Removes the event listener for the tray icon being double clicked.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'double-click'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronKeyboardEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardEvent:interface" }, { "kind": "Content", "text": ", bounds: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(6)", "docComment": "/**\n * Removes the event listener for a drag operation ending.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'drag-end'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(7)", "docComment": "/**\n * Removes the event listener for a drag operation entering the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'drag-enter'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(8)", "docComment": "/**\n * Removes the event listener for a drag operation exiting the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'drag-leave'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#removeListener:member(9)", "docComment": "/**\n * Removes the event listener for dragged items being dropped on the tray icon.\n *\n * @param event - The event name.\n *\n * @param listener - The event handler to remove.\n *\n * @returns This tray instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'drop'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "removeListener" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#setContextMenu:member(1)", "docComment": "/**\n * Sets the context menu for this icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setContextMenu(menu: " }, { "kind": "Reference", "text": "ElectronMenu", "canonicalReference": "obsidian-typings!ElectronMenu:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setContextMenu" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#setIgnoreDoubleClickEvents:member(1)", "docComment": "/**\n * Sets the option to ignore double click events. Ignoring these events allows you to detect every individual click of the tray icon. `darwin` only.\n *\n * @param ignore - Whether to ignore double click events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIgnoreDoubleClickEvents(ignore: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "ignore", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIgnoreDoubleClickEvents" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#setImage:member(1)", "docComment": "/**\n * Sets the `image` associated with this tray icon.\n *\n * @param image - The image to use as the tray icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setImage(image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "image", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setImage" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#setPressedImage:member(1)", "docComment": "/**\n * Sets the `image` associated with this tray icon when pressed on macOS. `darwin` only.\n *\n * @param image - The image to use as the pressed tray icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPressedImage(image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "image", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setPressedImage" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#setTitle:member(1)", "docComment": "/**\n * Sets the title displayed next to the tray icon in the status bar (Support ANSI colors). `darwin` only.\n *\n * @param title - The title to display next to the tray icon.\n *\n * @param options - Options describing how the title is displayed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTitle(title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronTitleOptions", "canonicalReference": "obsidian-typings!ElectronTitleOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "setTitle" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ElectronTray#setToolTip:member(1)", "docComment": "/**\n * Sets the hover text for this tray icon.\n *\n * @param toolTip - The hover text for this tray icon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setToolTip(toolTip: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "toolTip", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setToolTip" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronUploadData:interface", "docComment": "/**\n * A chunk of upload data attached to a network request.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronUploadData " } ], "fileUrlPath": "src/electron/internals/ElectronUploadData.d.ts", "releaseTag": "Public", "name": "ElectronUploadData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadData#blobUUID:member", "docComment": "/**\n * UUID of blob data. Use `Session.getBlobData` to retrieve the data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blobUUID?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "blobUUID", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadData#bytes:member", "docComment": "/**\n * Content being sent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bytes: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bytes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadData#file:member", "docComment": "/**\n * Path of file being uploaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronUploadFile:interface", "docComment": "/**\n * A file to be uploaded as part of a request body.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronUploadFile " } ], "fileUrlPath": "src/electron/internals/ElectronUploadFile.d.ts", "releaseTag": "Public", "name": "ElectronUploadFile", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadFile#filePath:member", "docComment": "/**\n * Path of file to be uploaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadFile#length:member", "docComment": "/**\n * Number of bytes to read from `offset`.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadFile#modificationTime:member", "docComment": "/**\n * Last modification time in number of seconds since the UNIX epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modificationTime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modificationTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadFile#offset:member", "docComment": "/**\n * Offset in bytes to start reading from.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadFile#type:member", "docComment": "/**\n * The upload data type discriminant.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'file'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronUploadProgress:interface", "docComment": "/**\n * Progress information about the upload portion of a `ClientRequest`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronUploadProgress " } ], "fileUrlPath": "src/electron/internals/ElectronUploadProgress.d.ts", "releaseTag": "Public", "name": "ElectronUploadProgress", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadProgress#active:member", "docComment": "/**\n * Whether the request is currently active. If this is `false` no other properties will be set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "active: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "active", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadProgress#current:member", "docComment": "/**\n * The number of bytes that have been uploaded so far.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "current: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "current", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadProgress#started:member", "docComment": "/**\n * Whether the upload has started. If this is `false` both `current` and `total` will be set to `0`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "started: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "started", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadProgress#total:member", "docComment": "/**\n * The number of bytes that will be uploaded this request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "total: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "total", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronUploadRawData:interface", "docComment": "/**\n * Raw data to be uploaded as part of a request body.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronUploadRawData " } ], "fileUrlPath": "src/electron/internals/ElectronUploadRawData.d.ts", "releaseTag": "Public", "name": "ElectronUploadRawData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadRawData#bytes:member", "docComment": "/**\n * Data to be uploaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bytes: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bytes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUploadRawData#type:member", "docComment": "/**\n * The upload data type discriminant.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'rawData'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes:interface", "docComment": "/**\n * Maps `NSUserDefaults` type names to their corresponding TypeScript types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronUserDefaultTypes " } ], "fileUrlPath": "src/electron/internals/ElectronUserDefaultTypes.d.ts", "releaseTag": "Public", "name": "ElectronUserDefaultTypes", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes#array:member", "docComment": "/**\n * An array value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "array: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "array", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes#boolean:member", "docComment": "/**\n * A boolean value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "boolean: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "boolean", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes#dictionary:member", "docComment": "/**\n * A dictionary value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dictionary: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dictionary", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes#double:member", "docComment": "/**\n * A double-precision floating-point value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "double: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "double", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes#float:member", "docComment": "/**\n * A single-precision floating-point value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "float: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "float", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes#integer:member", "docComment": "/**\n * An integer value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "integer: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "integer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes#string:member", "docComment": "/**\n * A string value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "string: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "string", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronUserDefaultTypes#url:member", "docComment": "/**\n * A URL value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronVisibleOnAllWorkspacesOptions:interface", "docComment": "/**\n * Options for {@link ElectronBrowserWindow.setVisibleOnAllWorkspaces}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronVisibleOnAllWorkspacesOptions " } ], "fileUrlPath": "src/electron/internals/ElectronVisibleOnAllWorkspacesOptions.d.ts", "releaseTag": "Public", "name": "ElectronVisibleOnAllWorkspacesOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronVisibleOnAllWorkspacesOptions#skipTransformProcessType:member", "docComment": "/**\n * Calling `setVisibleOnAllWorkspaces` will by default transform the process type between `UIElementApplication` and `ForegroundApplication` to ensure the correct behavior. However, this will hide the window and dock for a short time every time it is called. If the window is already of type `UIElementApplication`, this transformation can be bypassed by passing `true` (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skipTransformProcessType?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "skipTransformProcessType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronVisibleOnAllWorkspacesOptions#visibleOnFullScreen:member", "docComment": "/**\n * Sets whether the window should be visible above fullscreen windows (macOS only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "visibleOnFullScreen?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "visibleOnFullScreen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebContents:interface", "docComment": "/**\n * Electron WebContents for rendering and controlling a web page.\n *\n * Note: the upstream static factories (`fromId`, `fromDevToolsTargetId`, `getAllWebContents`, `getFocusedWebContents`) cannot be expressed on a plain interface and are therefore omitted here.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebContents " } ], "fileUrlPath": "src/electron/internals/ElectronWebContents.d.ts", "releaseTag": "Public", "name": "ElectronWebContents", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(1)", "docComment": "/**\n * Registers a listener for the `before-input-event` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `before-input-event` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'before-input-event'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", input: " }, { "kind": "Reference", "text": "ElectronInput", "canonicalReference": "obsidian-typings!ElectronInput:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(10)", "docComment": "/**\n * Registers a listener for the `devtools-focused` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-focused` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'devtools-focused'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(11)", "docComment": "/**\n * Registers a listener for the `devtools-opened` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-opened` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'devtools-opened'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(12)", "docComment": "/**\n * Registers a listener for the `devtools-reload-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-reload-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'devtools-reload-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(13)", "docComment": "/**\n * Registers a listener for the `did-attach-webview` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-attach-webview` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-attach-webview'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(14)", "docComment": "/**\n * Registers a listener for the `did-change-theme-color` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-change-theme-color` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-change-theme-color'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", color: null | string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(15)", "docComment": "/**\n * Registers a listener for the `did-create-window` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-create-window` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-create-window'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronDidCreateWindowDetails", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(16)", "docComment": "/**\n * Registers a listener for the `did-fail-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-fail-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-fail-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(17)", "docComment": "/**\n * Registers a listener for the `did-fail-provisional-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-fail-provisional-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-fail-provisional-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(18)", "docComment": "/**\n * Registers a listener for the `did-finish-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-finish-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-finish-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(19)", "docComment": "/**\n * Registers a listener for the `did-frame-finish-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-frame-finish-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-frame-finish-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(2)", "docComment": "/**\n * Registers a listener for the `blur` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `blur` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(20)", "docComment": "/**\n * Registers a listener for the `did-frame-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-frame-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-frame-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, httpResponseCode: number, httpStatusText: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(21)", "docComment": "/**\n * Registers a listener for the `did-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, httpResponseCode: number, httpStatusText: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(22)", "docComment": "/**\n * Registers a listener for the `did-navigate-in-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-navigate-in-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-navigate-in-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(23)", "docComment": "/**\n * Registers a listener for the `did-redirect-navigation` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-redirect-navigation` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-redirect-navigation'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(24)", "docComment": "/**\n * Registers a listener for the `did-start-loading` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-start-loading` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-start-loading'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(25)", "docComment": "/**\n * Registers a listener for the `did-start-navigation` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-start-navigation` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-start-navigation'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(26)", "docComment": "/**\n * Registers a listener for the `did-stop-loading` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-stop-loading` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'did-stop-loading'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(27)", "docComment": "/**\n * Registers a listener for the `dom-ready` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `dom-ready` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'dom-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(28)", "docComment": "/**\n * Registers a listener for the `enter-html-full-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `enter-html-full-screen` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'enter-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(29)", "docComment": "/**\n * Registers a listener for the `focus` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `focus` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(3)", "docComment": "/**\n * Registers a listener for the `certificate-error` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `certificate-error` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'certificate-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, error: string, certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ", callback: (isTrusted: boolean) => void, isMainFrame: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(30)", "docComment": "/**\n * Registers a listener for the `found-in-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `found-in-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'found-in-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", result: " }, { "kind": "Reference", "text": "ElectronResult", "canonicalReference": "obsidian-typings!ElectronResult:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(31)", "docComment": "/**\n * Registers a listener for the `frame-created` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `frame-created` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'frame-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronFrameCreatedDetails", "canonicalReference": "obsidian-typings!ElectronFrameCreatedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(32)", "docComment": "/**\n * Registers a listener for the `ipc-message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `ipc-message` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'ipc-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", channel: string, ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(33)", "docComment": "/**\n * Registers a listener for the `ipc-message-sync` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `ipc-message-sync` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'ipc-message-sync'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", channel: string, ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 33, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(34)", "docComment": "/**\n * Registers a listener for the `leave-html-full-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `leave-html-full-screen` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'leave-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 34, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(35)", "docComment": "/**\n * Registers a listener for the `login` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `login` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", authenticationResponseDetails: " }, { "kind": "Reference", "text": "ElectronAuthenticationResponseDetails", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface" }, { "kind": "Content", "text": ", authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 35, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(36)", "docComment": "/**\n * Registers a listener for the `media-paused` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `media-paused` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'media-paused'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 36, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(37)", "docComment": "/**\n * Registers a listener for the `media-started-playing` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `media-started-playing` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'media-started-playing'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 37, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(38)", "docComment": "/**\n * Registers a listener for the `new-window` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `new-window` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'new-window'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronNewWindowWebContentsEvent", "canonicalReference": "obsidian-typings!ElectronNewWindowWebContentsEvent:interface" }, { "kind": "Content", "text": ", url: string, frameName: string, disposition: 'background-tab' | 'default' | 'foreground-tab' | 'new-window' | 'other' | 'save-to-disk', options: " }, { "kind": "Reference", "text": "BrowserWindowConstructorOptions", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions:interface" }, { "kind": "Content", "text": ", additionalFeatures: string[], referrer: " }, { "kind": "Reference", "text": "ElectronReferrer", "canonicalReference": "obsidian-typings!ElectronReferrer:interface" }, { "kind": "Content", "text": ", postBody: " }, { "kind": "Reference", "text": "ElectronPostBody", "canonicalReference": "obsidian-typings!ElectronPostBody:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 38, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(39)", "docComment": "/**\n * Registers a listener for the `page-favicon-updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `page-favicon-updated` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'page-favicon-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", favicons: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 39, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(4)", "docComment": "/**\n * Registers a listener for the `console-message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `console-message` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'console-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", level: number, message: string, line: number, sourceId: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(40)", "docComment": "/**\n * Registers a listener for the `page-title-updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `page-title-updated` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'page-title-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", title: string, explicitSet: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 40, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(41)", "docComment": "/**\n * Registers a listener for the `paint` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `paint` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'paint'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", dirtyRect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 41, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(42)", "docComment": "/**\n * Registers a listener for the `plugin-crashed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `plugin-crashed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'plugin-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", name: string, version: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 42, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(43)", "docComment": "/**\n * Registers a listener for the `preferred-size-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `preferred-size-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'preferred-size-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preferredSize: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 43, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(44)", "docComment": "/**\n * Registers a listener for the `preload-error` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `preload-error` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'preload-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preloadPath: string, error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 44, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(45)", "docComment": "/**\n * Registers a listener for the `render-process-gone` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `render-process-gone` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'render-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRenderProcessGoneDetails", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 45, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(46)", "docComment": "/**\n * Registers a listener for the `responsive` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `responsive` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'responsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 46, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(47)", "docComment": "/**\n * Registers a listener for the `select-bluetooth-device` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `select-bluetooth-device` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'select-bluetooth-device'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", devices: " }, { "kind": "Reference", "text": "ElectronBluetoothDevice", "canonicalReference": "obsidian-typings!ElectronBluetoothDevice:interface" }, { "kind": "Content", "text": "[], callback: (deviceId: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 47, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(48)", "docComment": "/**\n * Registers a listener for the `select-client-certificate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `select-client-certificate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'select-client-certificate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, certificateList: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": "[], callback: (certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 48, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(49)", "docComment": "/**\n * Registers a listener for the `unresponsive` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `unresponsive` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'unresponsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 49, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(5)", "docComment": "/**\n * Registers a listener for the `context-menu` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `context-menu` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'context-menu'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", params: " }, { "kind": "Reference", "text": "ElectronContextMenuParams", "canonicalReference": "obsidian-typings!ElectronContextMenuParams:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(50)", "docComment": "/**\n * Registers a listener for the `update-target-url` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `update-target-url` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'update-target-url'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 50, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(51)", "docComment": "/**\n * Registers a listener for the `will-attach-webview` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-attach-webview` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-attach-webview'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webPreferences: " }, { "kind": "Reference", "text": "WebPreferences", "canonicalReference": "obsidian-typings!WebPreferences:interface" }, { "kind": "Content", "text": ", params: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 51, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(52)", "docComment": "/**\n * Registers a listener for the `will-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 52, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(53)", "docComment": "/**\n * Registers a listener for the `will-prevent-unload` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-prevent-unload` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-prevent-unload'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 53, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(54)", "docComment": "/**\n * Registers a listener for the `will-redirect` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-redirect` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-redirect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 54, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(55)", "docComment": "/**\n * Registers a listener for the `zoom-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `zoom-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'zoom-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", zoomDirection: 'in' | 'out') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 55, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(6)", "docComment": "/**\n * Registers a listener for the `crashed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `crashed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(7)", "docComment": "/**\n * Registers a listener for the `cursor-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `cursor-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'cursor-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ", scale: number, size: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ", hotspot: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(8)", "docComment": "/**\n * Registers a listener for the `destroyed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `destroyed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'destroyed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addListener:member(9)", "docComment": "/**\n * Registers a listener for the `devtools-closed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-closed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'devtools-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#addWorkSpace:member(1)", "docComment": "/**\n * Adds the specified path to the DevTools workspace.\n *\n * @param path - The path to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addWorkSpace(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addWorkSpace" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#audioMuted:member", "docComment": "/**\n * Whether this page is muted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "audioMuted: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "audioMuted", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#backgroundThrottling:member", "docComment": "/**\n * Whether this web contents throttles animations and timers when the page becomes backgrounded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundThrottling: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backgroundThrottling", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#beginFrameSubscription:member(1)", "docComment": "/**\n * Begins subscribing for presentation events and captured frames.\n *\n * @param onlyDirty - Whether the captured image should contain only the repainted area.\n *\n * @param callback - Called with the captured frame image and the repainted rect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "beginFrameSubscription(onlyDirty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ", dirtyRect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "onlyDirty", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "beginFrameSubscription" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#beginFrameSubscription:member(2)", "docComment": "/**\n * Begins subscribing for presentation events and captured frames.\n *\n * @param callback - Called with the captured frame image and the repainted rect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "beginFrameSubscription(callback: " }, { "kind": "Content", "text": "(image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ", dirtyRect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "beginFrameSubscription" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#canGoBack:member(1)", "docComment": "/**\n * Returns whether the browser can go back to the previous web page.\n *\n * @returns Whether the browser can go back.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canGoBack(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canGoBack" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#canGoForward:member(1)", "docComment": "/**\n * Returns whether the browser can go forward to the next web page.\n *\n * @returns Whether the browser can go forward.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canGoForward(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canGoForward" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#canGoToOffset:member(1)", "docComment": "/**\n * Returns whether the web page can go to the given offset.\n *\n * @param offset - The offset from the current entry.\n *\n * @returns Whether the web page can go to the offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canGoToOffset(offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "offset", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "canGoToOffset" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#capturePage:member(1)", "docComment": "/**\n * Captures a snapshot of the page within `rect`. Omitting `rect` captures the whole visible page.\n *\n * @param rect - The area of the page to capture.\n *\n * @returns A promise resolving with a native image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "capturePage(rect?: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "capturePage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#clearHistory:member(1)", "docComment": "/**\n * Clears the navigation history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearHistory(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearHistory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#closeDevTools:member(1)", "docComment": "/**\n * Closes the developer tools.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeDevTools(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "closeDevTools" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#copy:member(1)", "docComment": "/**\n * Executes the editing command `copy` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "copy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#copyImageAt:member(1)", "docComment": "/**\n * Copies the image at the given position to the clipboard.\n *\n * @param x - The x coordinate.\n *\n * @param y - The y coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copyImageAt(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "copyImageAt" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#cut:member(1)", "docComment": "/**\n * Executes the editing command `cut` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cut(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cut" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#debugger:member", "docComment": "/**\n * The debugger instance for this web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly debugger: " }, { "kind": "Reference", "text": "ElectronDebugger", "canonicalReference": "obsidian-typings!ElectronDebugger:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "debugger", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#decrementCapturerCount:member(1)", "docComment": "/**\n * Decreases the capturer count by one.\n *\n * @param stayHidden - Whether to decrease the hidden capturer count instead.\n *\n * @param stayAwake - Whether the page should stay awake.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "decrementCapturerCount(stayHidden?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", stayAwake?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "stayHidden", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "stayAwake", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "decrementCapturerCount" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#delete:member(1)", "docComment": "/**\n * Executes the editing command `delete` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "delete(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "delete" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#devToolsWebContents:member", "docComment": "/**\n * The DevTools web contents associated with this web contents, or `null` when DevTools is closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly devToolsWebContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "devToolsWebContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#disableDeviceEmulation:member(1)", "docComment": "/**\n * Disables device emulation enabled by `enableDeviceEmulation`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableDeviceEmulation(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "disableDeviceEmulation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#downloadURL:member(1)", "docComment": "/**\n * Initiates a download of the resource at `url` without navigating.\n *\n * @param url - The URL of the resource to download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadURL(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "downloadURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#enableDeviceEmulation:member(1)", "docComment": "/**\n * Enables device emulation with the given parameters.\n *\n * @param parameters - The device emulation parameters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableDeviceEmulation(parameters: " }, { "kind": "Reference", "text": "ElectronParameters", "canonicalReference": "obsidian-typings!ElectronParameters:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "parameters", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "enableDeviceEmulation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#endFrameSubscription:member(1)", "docComment": "/**\n * Ends subscribing for frame presentation events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "endFrameSubscription(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "endFrameSubscription" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#executeJavaScript:member(1)", "docComment": "/**\n * Evaluates `code` in the page.\n *\n * @param code - The JavaScript code to execute.\n *\n * @param userGesture - Whether the execution should be treated as a user gesture.\n *\n * @returns A promise resolving with the result of the executed code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeJavaScript(code: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userGesture?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userGesture", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "executeJavaScript" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#executeJavaScriptInIsolatedWorld:member(1)", "docComment": "/**\n * Works like `executeJavaScript` but evaluates `scripts` in an isolated context.\n *\n * @param worldId - The id of the isolated world.\n *\n * @param scripts - The scripts to evaluate.\n *\n * @param userGesture - Whether the execution should be treated as a user gesture.\n *\n * @returns A promise resolving with the result of the executed code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeJavaScriptInIsolatedWorld(worldId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", scripts: " }, { "kind": "Reference", "text": "ElectronWebSource", "canonicalReference": "obsidian-typings!ElectronWebSource:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", userGesture?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "worldId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "scripts", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "userGesture", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "executeJavaScriptInIsolatedWorld" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#findInPage:member(1)", "docComment": "/**\n * Starts a request to find all matches for `text` in the web page.\n *\n * @param text - The text to search for.\n *\n * @param options - Options for the find request.\n *\n * @returns The request id used for the request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findInPage(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronFindInPageOptions", "canonicalReference": "obsidian-typings!ElectronFindInPageOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "findInPage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#focus:member(1)", "docComment": "/**\n * Focuses the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#forcefullyCrashRenderer:member(1)", "docComment": "/**\n * Forcefully terminates the renderer process currently hosting this web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forcefullyCrashRenderer(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "forcefullyCrashRenderer" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#frameRate:member", "docComment": "/**\n * The frame rate of the web contents. Only applicable when offscreen rendering is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "frameRate: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "frameRate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getAllSharedWorkers:member(1)", "docComment": "/**\n * Returns information about all shared workers.\n *\n * @returns Information about all shared workers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAllSharedWorkers(): " }, { "kind": "Reference", "text": "ElectronSharedWorkerInfo", "canonicalReference": "obsidian-typings!ElectronSharedWorkerInfo:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAllSharedWorkers" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getBackgroundThrottling:member(1)", "docComment": "/**\n * Returns whether this web contents throttles animations and timers when backgrounded.\n *\n * @returns Whether background throttling is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBackgroundThrottling(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBackgroundThrottling" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getFrameRate:member(1)", "docComment": "/**\n * Returns the current frame rate when offscreen rendering is enabled.\n *\n * @returns The current frame rate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFrameRate(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFrameRate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getMediaSourceId:member(1)", "docComment": "/**\n * Returns the identifier of a web contents stream.\n *\n * @param requestWebContents - The web contents that would access the stream.\n *\n * @returns The identifier of the web contents stream.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMediaSourceId(requestWebContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "requestWebContents", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getMediaSourceId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getOSProcessId:member(1)", "docComment": "/**\n * Returns the operating system `pid` of the associated renderer process.\n *\n * @returns The operating system process id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOSProcessId(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getOSProcessId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getPrinters:member(1)", "docComment": "/**\n * Returns the system printer list.\n *\n * @returns The system printer list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPrinters(): " }, { "kind": "Reference", "text": "ElectronPrinterInfo", "canonicalReference": "obsidian-typings!ElectronPrinterInfo:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPrinters" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getPrintersAsync:member(1)", "docComment": "/**\n * Returns the system printer list.\n *\n * @returns A promise resolving with the system printer list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPrintersAsync(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronPrinterInfo", "canonicalReference": "obsidian-typings!ElectronPrinterInfo:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPrintersAsync" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getProcessId:member(1)", "docComment": "/**\n * Returns the Chromium internal `pid` of the associated renderer.\n *\n * @returns The Chromium internal process id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getProcessId(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getProcessId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getTitle:member(1)", "docComment": "/**\n * Returns the title of the current web page.\n *\n * @returns The page title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTitle(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTitle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getType:member(1)", "docComment": "/**\n * Returns the type of the web contents.\n *\n * @returns The type of the web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getType(): " }, { "kind": "Content", "text": "'backgroundPage' | 'browserView' | 'offscreen' | 'remote' | 'webview' | 'window'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getURL:member(1)", "docComment": "/**\n * Returns the URL of the current web page.\n *\n * @returns The current URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getURL(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getUserAgent:member(1)", "docComment": "/**\n * Returns the user agent for this web page.\n *\n * @returns The user agent string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getUserAgent(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getUserAgent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getWebRTCIPHandlingPolicy:member(1)", "docComment": "/**\n * Returns the WebRTC IP handling policy.\n *\n * @returns The WebRTC IP handling policy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getWebRTCIPHandlingPolicy(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWebRTCIPHandlingPolicy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getZoomFactor:member(1)", "docComment": "/**\n * Returns the current zoom factor.\n *\n * @returns The current zoom factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getZoomFactor(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getZoomFactor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#getZoomLevel:member(1)", "docComment": "/**\n * Returns the current zoom level.\n *\n * @returns The current zoom level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getZoomLevel(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getZoomLevel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#goBack:member(1)", "docComment": "/**\n * Makes the browser go back a web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goBack(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "goBack" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#goForward:member(1)", "docComment": "/**\n * Makes the browser go forward a web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goForward(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "goForward" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#goToIndex:member(1)", "docComment": "/**\n * Navigates the browser to the specified absolute web page index.\n *\n * @param index - The absolute web page index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goToIndex(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "goToIndex" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#goToOffset:member(1)", "docComment": "/**\n * Navigates to the specified offset from the current entry.\n *\n * @param offset - The offset from the current entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goToOffset(offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "offset", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "goToOffset" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#hostWebContents:member", "docComment": "/**\n * The web contents that might own this web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly hostWebContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "hostWebContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#id:member", "docComment": "/**\n * The unique id of this web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#incrementCapturerCount:member(1)", "docComment": "/**\n * Increases the capturer count by one.\n *\n * @param size - The preferred size for the captured page.\n *\n * @param stayHidden - Whether the page should stay hidden.\n *\n * @param stayAwake - Whether the page should stay awake.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "incrementCapturerCount(size?: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ", stayHidden?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", stayAwake?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "size", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "stayHidden", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "stayAwake", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "incrementCapturerCount" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#insertCSS:member(1)", "docComment": "/**\n * Injects CSS into the current web page and returns a unique key for the inserted stylesheet.\n *\n * @param css - The CSS to inject.\n *\n * @param options - Options for inserting the CSS.\n *\n * @returns A promise resolving with the key for the inserted CSS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertCSS(css: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronInsertCSSOptions", "canonicalReference": "obsidian-typings!ElectronInsertCSSOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "css", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "insertCSS" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#insertText:member(1)", "docComment": "/**\n * Inserts `text` into the focused element.\n *\n * @param text - The text to insert.\n *\n * @returns A promise that resolves when the text is inserted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertText(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "insertText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#inspectElement:member(1)", "docComment": "/**\n * Starts inspecting the element at the given position.\n *\n * @param x - The x coordinate.\n *\n * @param y - The y coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inspectElement(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "inspectElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#inspectServiceWorker:member(1)", "docComment": "/**\n * Opens the developer tools for the service worker context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inspectServiceWorker(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "inspectServiceWorker" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#inspectSharedWorker:member(1)", "docComment": "/**\n * Opens the developer tools for the shared worker context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inspectSharedWorker(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "inspectSharedWorker" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#inspectSharedWorkerById:member(1)", "docComment": "/**\n * Inspects the shared worker based on its id.\n *\n * @param workerId - The id of the shared worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inspectSharedWorkerById(workerId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "workerId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "inspectSharedWorkerById" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#invalidate:member(1)", "docComment": "/**\n * Schedules a full repaint of the window this web contents is in.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "invalidate(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "invalidate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isAudioMuted:member(1)", "docComment": "/**\n * Returns whether this page has been muted.\n *\n * @returns Whether the page is muted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAudioMuted(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isAudioMuted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isBeingCaptured:member(1)", "docComment": "/**\n * Returns whether this page is being captured.\n *\n * @returns Whether the page is being captured.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isBeingCaptured(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isBeingCaptured" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isCrashed:member(1)", "docComment": "/**\n * Returns whether the renderer process has crashed.\n *\n * @returns Whether the renderer process has crashed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isCrashed(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isCrashed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isCurrentlyAudible:member(1)", "docComment": "/**\n * Returns whether audio is currently playing.\n *\n * @returns Whether audio is currently playing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isCurrentlyAudible(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isCurrentlyAudible" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isDestroyed:member(1)", "docComment": "/**\n * Returns whether the web page is destroyed.\n *\n * @returns Whether the web page is destroyed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDestroyed(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isDestroyed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isDevToolsFocused:member(1)", "docComment": "/**\n * Returns whether the DevTools view is focused.\n *\n * @returns Whether the DevTools view is focused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDevToolsFocused(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isDevToolsFocused" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isDevToolsOpened:member(1)", "docComment": "/**\n * Returns whether the DevTools is opened.\n *\n * @returns Whether the DevTools is opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDevToolsOpened(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isDevToolsOpened" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isFocused:member(1)", "docComment": "/**\n * Returns whether the web page is focused.\n *\n * @returns Whether the web page is focused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isFocused(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isFocused" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isLoading:member(1)", "docComment": "/**\n * Returns whether the web page is still loading resources.\n *\n * @returns Whether the page is loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isLoading(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isLoading" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isLoadingMainFrame:member(1)", "docComment": "/**\n * Returns whether the main frame is still loading.\n *\n * @returns Whether the main frame is loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isLoadingMainFrame(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isLoadingMainFrame" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isOffscreen:member(1)", "docComment": "/**\n * Returns whether offscreen rendering is enabled.\n *\n * @returns Whether offscreen rendering is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isOffscreen(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isOffscreen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isPainting:member(1)", "docComment": "/**\n * Returns whether it is currently painting when offscreen rendering is enabled.\n *\n * @returns Whether it is currently painting.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPainting(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isPainting" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#isWaitingForResponse:member(1)", "docComment": "/**\n * Returns whether the web page is waiting for a first response from the main resource.\n *\n * @returns Whether the page is waiting for a response.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isWaitingForResponse(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isWaitingForResponse" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#loadFile:member(1)", "docComment": "/**\n * Loads the given file in the window.\n *\n * @param filePath - The path to the HTML file relative to the root of the application.\n *\n * @param options - Options for loading the file.\n *\n * @returns A promise that resolves when the page has finished loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadFile(filePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronBrowserWindowLoadFileOptions", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadFileOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filePath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#loadURL:member(1)", "docComment": "/**\n * Loads the `url` in the window.\n *\n * @param url - The URL to load. Must contain the protocol prefix.\n *\n * @param options - Options for loading the URL.\n *\n * @returns A promise that resolves when the page has finished loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadURL(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronBrowserWindowLoadURLOptions", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadURL" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#mainFrame:member", "docComment": "/**\n * The top frame of the page's frame hierarchy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly mainFrame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "mainFrame", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(1)", "docComment": "/**\n * Registers a listener for the `before-input-event` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `before-input-event` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'before-input-event'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", input: " }, { "kind": "Reference", "text": "ElectronInput", "canonicalReference": "obsidian-typings!ElectronInput:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(10)", "docComment": "/**\n * Registers a listener for the `devtools-focused` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-focused` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'devtools-focused'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(11)", "docComment": "/**\n * Registers a listener for the `devtools-opened` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-opened` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'devtools-opened'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(12)", "docComment": "/**\n * Registers a listener for the `devtools-reload-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-reload-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'devtools-reload-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(13)", "docComment": "/**\n * Registers a listener for the `did-attach-webview` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-attach-webview` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-attach-webview'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(14)", "docComment": "/**\n * Registers a listener for the `did-change-theme-color` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-change-theme-color` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-change-theme-color'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", color: null | string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(15)", "docComment": "/**\n * Registers a listener for the `did-create-window` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-create-window` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-create-window'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronDidCreateWindowDetails", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(16)", "docComment": "/**\n * Registers a listener for the `did-fail-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-fail-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-fail-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(17)", "docComment": "/**\n * Registers a listener for the `did-fail-provisional-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-fail-provisional-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-fail-provisional-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(18)", "docComment": "/**\n * Registers a listener for the `did-finish-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-finish-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-finish-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(19)", "docComment": "/**\n * Registers a listener for the `did-frame-finish-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-frame-finish-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-frame-finish-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(2)", "docComment": "/**\n * Registers a listener for the `blur` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `blur` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(20)", "docComment": "/**\n * Registers a listener for the `did-frame-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-frame-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-frame-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, httpResponseCode: number, httpStatusText: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(21)", "docComment": "/**\n * Registers a listener for the `did-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, httpResponseCode: number, httpStatusText: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(22)", "docComment": "/**\n * Registers a listener for the `did-navigate-in-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-navigate-in-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-navigate-in-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(23)", "docComment": "/**\n * Registers a listener for the `did-redirect-navigation` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-redirect-navigation` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-redirect-navigation'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(24)", "docComment": "/**\n * Registers a listener for the `did-start-loading` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-start-loading` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-start-loading'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(25)", "docComment": "/**\n * Registers a listener for the `did-start-navigation` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-start-navigation` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-start-navigation'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(26)", "docComment": "/**\n * Registers a listener for the `did-stop-loading` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-stop-loading` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'did-stop-loading'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(27)", "docComment": "/**\n * Registers a listener for the `dom-ready` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `dom-ready` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'dom-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(28)", "docComment": "/**\n * Registers a listener for the `enter-html-full-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `enter-html-full-screen` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'enter-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(29)", "docComment": "/**\n * Registers a listener for the `focus` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `focus` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(3)", "docComment": "/**\n * Registers a listener for the `certificate-error` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `certificate-error` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'certificate-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, error: string, certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ", callback: (isTrusted: boolean) => void, isMainFrame: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(30)", "docComment": "/**\n * Registers a listener for the `found-in-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `found-in-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'found-in-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", result: " }, { "kind": "Reference", "text": "ElectronResult", "canonicalReference": "obsidian-typings!ElectronResult:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(31)", "docComment": "/**\n * Registers a listener for the `frame-created` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `frame-created` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'frame-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronFrameCreatedDetails", "canonicalReference": "obsidian-typings!ElectronFrameCreatedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(32)", "docComment": "/**\n * Registers a listener for the `ipc-message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `ipc-message` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'ipc-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", channel: string, ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(33)", "docComment": "/**\n * Registers a listener for the `ipc-message-sync` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `ipc-message-sync` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'ipc-message-sync'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", channel: string, ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 33, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(34)", "docComment": "/**\n * Registers a listener for the `leave-html-full-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `leave-html-full-screen` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'leave-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 34, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(35)", "docComment": "/**\n * Registers a listener for the `login` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `login` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", authenticationResponseDetails: " }, { "kind": "Reference", "text": "ElectronAuthenticationResponseDetails", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface" }, { "kind": "Content", "text": ", authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 35, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(36)", "docComment": "/**\n * Registers a listener for the `media-paused` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `media-paused` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'media-paused'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 36, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(37)", "docComment": "/**\n * Registers a listener for the `media-started-playing` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `media-started-playing` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'media-started-playing'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 37, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(38)", "docComment": "/**\n * Registers a listener for the `new-window` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `new-window` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'new-window'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronNewWindowWebContentsEvent", "canonicalReference": "obsidian-typings!ElectronNewWindowWebContentsEvent:interface" }, { "kind": "Content", "text": ", url: string, frameName: string, disposition: 'background-tab' | 'default' | 'foreground-tab' | 'new-window' | 'other' | 'save-to-disk', options: " }, { "kind": "Reference", "text": "BrowserWindowConstructorOptions", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions:interface" }, { "kind": "Content", "text": ", additionalFeatures: string[], referrer: " }, { "kind": "Reference", "text": "ElectronReferrer", "canonicalReference": "obsidian-typings!ElectronReferrer:interface" }, { "kind": "Content", "text": ", postBody: " }, { "kind": "Reference", "text": "ElectronPostBody", "canonicalReference": "obsidian-typings!ElectronPostBody:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 38, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(39)", "docComment": "/**\n * Registers a listener for the `page-favicon-updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `page-favicon-updated` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'page-favicon-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", favicons: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 39, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(4)", "docComment": "/**\n * Registers a listener for the `console-message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `console-message` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'console-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", level: number, message: string, line: number, sourceId: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(40)", "docComment": "/**\n * Registers a listener for the `page-title-updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `page-title-updated` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'page-title-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", title: string, explicitSet: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 40, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(41)", "docComment": "/**\n * Registers a listener for the `paint` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `paint` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'paint'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", dirtyRect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 41, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(42)", "docComment": "/**\n * Registers a listener for the `plugin-crashed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `plugin-crashed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'plugin-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", name: string, version: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 42, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(43)", "docComment": "/**\n * Registers a listener for the `preferred-size-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `preferred-size-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'preferred-size-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preferredSize: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 43, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(44)", "docComment": "/**\n * Registers a listener for the `preload-error` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `preload-error` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'preload-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preloadPath: string, error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 44, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(45)", "docComment": "/**\n * Registers a listener for the `render-process-gone` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `render-process-gone` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'render-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRenderProcessGoneDetails", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 45, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(46)", "docComment": "/**\n * Registers a listener for the `responsive` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `responsive` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'responsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 46, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(47)", "docComment": "/**\n * Registers a listener for the `select-bluetooth-device` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `select-bluetooth-device` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'select-bluetooth-device'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", devices: " }, { "kind": "Reference", "text": "ElectronBluetoothDevice", "canonicalReference": "obsidian-typings!ElectronBluetoothDevice:interface" }, { "kind": "Content", "text": "[], callback: (deviceId: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 47, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(48)", "docComment": "/**\n * Registers a listener for the `select-client-certificate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `select-client-certificate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'select-client-certificate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, certificateList: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": "[], callback: (certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 48, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(49)", "docComment": "/**\n * Registers a listener for the `unresponsive` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `unresponsive` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'unresponsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 49, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(5)", "docComment": "/**\n * Registers a listener for the `context-menu` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `context-menu` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'context-menu'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", params: " }, { "kind": "Reference", "text": "ElectronContextMenuParams", "canonicalReference": "obsidian-typings!ElectronContextMenuParams:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(50)", "docComment": "/**\n * Registers a listener for the `update-target-url` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `update-target-url` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'update-target-url'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 50, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(51)", "docComment": "/**\n * Registers a listener for the `will-attach-webview` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-attach-webview` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-attach-webview'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webPreferences: " }, { "kind": "Reference", "text": "WebPreferences", "canonicalReference": "obsidian-typings!WebPreferences:interface" }, { "kind": "Content", "text": ", params: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 51, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(52)", "docComment": "/**\n * Registers a listener for the `will-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 52, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(53)", "docComment": "/**\n * Registers a listener for the `will-prevent-unload` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-prevent-unload` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-prevent-unload'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 53, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(54)", "docComment": "/**\n * Registers a listener for the `will-redirect` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-redirect` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-redirect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 54, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(55)", "docComment": "/**\n * Registers a listener for the `zoom-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `zoom-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'zoom-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", zoomDirection: 'in' | 'out') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 55, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(6)", "docComment": "/**\n * Registers a listener for the `crashed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `crashed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(7)", "docComment": "/**\n * Registers a listener for the `cursor-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `cursor-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'cursor-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ", scale: number, size: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ", hotspot: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(8)", "docComment": "/**\n * Registers a listener for the `destroyed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `destroyed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'destroyed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#on:member(9)", "docComment": "/**\n * Registers a listener for the `devtools-closed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-closed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'devtools-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `before-input-event` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `before-input-event` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'before-input-event'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", input: " }, { "kind": "Reference", "text": "ElectronInput", "canonicalReference": "obsidian-typings!ElectronInput:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(10)", "docComment": "/**\n * Registers a one-time listener for the `devtools-focused` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-focused` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'devtools-focused'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(11)", "docComment": "/**\n * Registers a one-time listener for the `devtools-opened` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-opened` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'devtools-opened'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(12)", "docComment": "/**\n * Registers a one-time listener for the `devtools-reload-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-reload-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'devtools-reload-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(13)", "docComment": "/**\n * Registers a one-time listener for the `did-attach-webview` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-attach-webview` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-attach-webview'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(14)", "docComment": "/**\n * Registers a one-time listener for the `did-change-theme-color` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-change-theme-color` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-change-theme-color'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", color: null | string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(15)", "docComment": "/**\n * Registers a one-time listener for the `did-create-window` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-create-window` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-create-window'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronDidCreateWindowDetails", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(16)", "docComment": "/**\n * Registers a one-time listener for the `did-fail-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-fail-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-fail-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(17)", "docComment": "/**\n * Registers a one-time listener for the `did-fail-provisional-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-fail-provisional-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-fail-provisional-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(18)", "docComment": "/**\n * Registers a one-time listener for the `did-finish-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-finish-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-finish-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(19)", "docComment": "/**\n * Registers a one-time listener for the `did-frame-finish-load` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-frame-finish-load` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-frame-finish-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(2)", "docComment": "/**\n * Registers a one-time listener for the `blur` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `blur` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(20)", "docComment": "/**\n * Registers a one-time listener for the `did-frame-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-frame-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-frame-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, httpResponseCode: number, httpStatusText: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(21)", "docComment": "/**\n * Registers a one-time listener for the `did-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, httpResponseCode: number, httpStatusText: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(22)", "docComment": "/**\n * Registers a one-time listener for the `did-navigate-in-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-navigate-in-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-navigate-in-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(23)", "docComment": "/**\n * Registers a one-time listener for the `did-redirect-navigation` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-redirect-navigation` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-redirect-navigation'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(24)", "docComment": "/**\n * Registers a one-time listener for the `did-start-loading` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-start-loading` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-start-loading'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(25)", "docComment": "/**\n * Registers a one-time listener for the `did-start-navigation` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-start-navigation` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-start-navigation'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(26)", "docComment": "/**\n * Registers a one-time listener for the `did-stop-loading` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `did-stop-loading` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'did-stop-loading'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(27)", "docComment": "/**\n * Registers a one-time listener for the `dom-ready` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `dom-ready` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'dom-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(28)", "docComment": "/**\n * Registers a one-time listener for the `enter-html-full-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `enter-html-full-screen` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'enter-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(29)", "docComment": "/**\n * Registers a one-time listener for the `focus` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `focus` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(3)", "docComment": "/**\n * Registers a one-time listener for the `certificate-error` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `certificate-error` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'certificate-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, error: string, certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ", callback: (isTrusted: boolean) => void, isMainFrame: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(30)", "docComment": "/**\n * Registers a one-time listener for the `found-in-page` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `found-in-page` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'found-in-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", result: " }, { "kind": "Reference", "text": "ElectronResult", "canonicalReference": "obsidian-typings!ElectronResult:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(31)", "docComment": "/**\n * Registers a one-time listener for the `frame-created` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `frame-created` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'frame-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronFrameCreatedDetails", "canonicalReference": "obsidian-typings!ElectronFrameCreatedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(32)", "docComment": "/**\n * Registers a one-time listener for the `ipc-message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `ipc-message` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'ipc-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", channel: string, ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(33)", "docComment": "/**\n * Registers a one-time listener for the `ipc-message-sync` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `ipc-message-sync` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'ipc-message-sync'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", channel: string, ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 33, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(34)", "docComment": "/**\n * Registers a one-time listener for the `leave-html-full-screen` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `leave-html-full-screen` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'leave-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 34, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(35)", "docComment": "/**\n * Registers a one-time listener for the `login` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `login` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", authenticationResponseDetails: " }, { "kind": "Reference", "text": "ElectronAuthenticationResponseDetails", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface" }, { "kind": "Content", "text": ", authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 35, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(36)", "docComment": "/**\n * Registers a one-time listener for the `media-paused` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `media-paused` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'media-paused'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 36, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(37)", "docComment": "/**\n * Registers a one-time listener for the `media-started-playing` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `media-started-playing` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'media-started-playing'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 37, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(38)", "docComment": "/**\n * Registers a one-time listener for the `new-window` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `new-window` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'new-window'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronNewWindowWebContentsEvent", "canonicalReference": "obsidian-typings!ElectronNewWindowWebContentsEvent:interface" }, { "kind": "Content", "text": ", url: string, frameName: string, disposition: 'background-tab' | 'default' | 'foreground-tab' | 'new-window' | 'other' | 'save-to-disk', options: " }, { "kind": "Reference", "text": "BrowserWindowConstructorOptions", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions:interface" }, { "kind": "Content", "text": ", additionalFeatures: string[], referrer: " }, { "kind": "Reference", "text": "ElectronReferrer", "canonicalReference": "obsidian-typings!ElectronReferrer:interface" }, { "kind": "Content", "text": ", postBody: " }, { "kind": "Reference", "text": "ElectronPostBody", "canonicalReference": "obsidian-typings!ElectronPostBody:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 38, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(39)", "docComment": "/**\n * Registers a one-time listener for the `page-favicon-updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `page-favicon-updated` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'page-favicon-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", favicons: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 39, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(4)", "docComment": "/**\n * Registers a one-time listener for the `console-message` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `console-message` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'console-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", level: number, message: string, line: number, sourceId: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(40)", "docComment": "/**\n * Registers a one-time listener for the `page-title-updated` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `page-title-updated` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'page-title-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", title: string, explicitSet: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 40, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(41)", "docComment": "/**\n * Registers a one-time listener for the `paint` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `paint` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'paint'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", dirtyRect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 41, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(42)", "docComment": "/**\n * Registers a one-time listener for the `plugin-crashed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `plugin-crashed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'plugin-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", name: string, version: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 42, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(43)", "docComment": "/**\n * Registers a one-time listener for the `preferred-size-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `preferred-size-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'preferred-size-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preferredSize: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 43, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(44)", "docComment": "/**\n * Registers a one-time listener for the `preload-error` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `preload-error` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'preload-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preloadPath: string, error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 44, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(45)", "docComment": "/**\n * Registers a one-time listener for the `render-process-gone` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `render-process-gone` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'render-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRenderProcessGoneDetails", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 45, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(46)", "docComment": "/**\n * Registers a one-time listener for the `responsive` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `responsive` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'responsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 46, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(47)", "docComment": "/**\n * Registers a one-time listener for the `select-bluetooth-device` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `select-bluetooth-device` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'select-bluetooth-device'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", devices: " }, { "kind": "Reference", "text": "ElectronBluetoothDevice", "canonicalReference": "obsidian-typings!ElectronBluetoothDevice:interface" }, { "kind": "Content", "text": "[], callback: (deviceId: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 47, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(48)", "docComment": "/**\n * Registers a one-time listener for the `select-client-certificate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `select-client-certificate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'select-client-certificate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, certificateList: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": "[], callback: (certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 48, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(49)", "docComment": "/**\n * Registers a one-time listener for the `unresponsive` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `unresponsive` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'unresponsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 49, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(5)", "docComment": "/**\n * Registers a one-time listener for the `context-menu` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `context-menu` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'context-menu'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", params: " }, { "kind": "Reference", "text": "ElectronContextMenuParams", "canonicalReference": "obsidian-typings!ElectronContextMenuParams:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(50)", "docComment": "/**\n * Registers a one-time listener for the `update-target-url` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `update-target-url` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'update-target-url'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 50, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(51)", "docComment": "/**\n * Registers a one-time listener for the `will-attach-webview` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-attach-webview` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-attach-webview'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webPreferences: " }, { "kind": "Reference", "text": "WebPreferences", "canonicalReference": "obsidian-typings!WebPreferences:interface" }, { "kind": "Content", "text": ", params: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 51, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(52)", "docComment": "/**\n * Registers a one-time listener for the `will-navigate` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-navigate` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 52, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(53)", "docComment": "/**\n * Registers a one-time listener for the `will-prevent-unload` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-prevent-unload` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-prevent-unload'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 53, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(54)", "docComment": "/**\n * Registers a one-time listener for the `will-redirect` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `will-redirect` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-redirect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 54, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(55)", "docComment": "/**\n * Registers a one-time listener for the `zoom-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `zoom-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'zoom-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", zoomDirection: 'in' | 'out') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 55, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(6)", "docComment": "/**\n * Registers a one-time listener for the `crashed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `crashed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(7)", "docComment": "/**\n * Registers a one-time listener for the `cursor-changed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `cursor-changed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'cursor-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ", scale: number, size: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ", hotspot: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(8)", "docComment": "/**\n * Registers a one-time listener for the `destroyed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `destroyed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'destroyed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#once:member(9)", "docComment": "/**\n * Registers a one-time listener for the `devtools-closed` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the `devtools-closed` event is emitted.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'devtools-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#openDevTools:member(1)", "docComment": "/**\n * Opens the developer tools.\n *\n * @param options - Options for the developer tools including `mode`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openDevTools(options?: " }, { "kind": "Reference", "text": "ElectronWebContentsDevToolsOptions", "canonicalReference": "obsidian-typings!ElectronWebContentsDevToolsOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "openDevTools" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#paste:member(1)", "docComment": "/**\n * Executes the editing command `paste` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paste(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "paste" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#pasteAndMatchStyle:member(1)", "docComment": "/**\n * Executes the editing command `pasteAndMatchStyle` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pasteAndMatchStyle(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "pasteAndMatchStyle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#postMessage:member(1)", "docComment": "/**\n * Sends a message to the renderer process, optionally transferring ownership of message ports.\n *\n * @param channel - The channel name.\n *\n * @param message - The message to send.\n *\n * @param transfer - Message ports whose ownership is transferred with the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postMessage(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", message: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", transfer?: " }, { "kind": "Reference", "text": "ElectronMessagePortMain", "canonicalReference": "obsidian-typings!ElectronMessagePortMain:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "transfer", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": true } ], "name": "postMessage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#print:member(1)", "docComment": "/**\n * Prints the window's web page.\n *\n * @param options - Options for printing.\n *\n * @param callback - Called with whether printing succeeded and any failure reason.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "print(options?: " }, { "kind": "Reference", "text": "ElectronWebContentsPrintOptions", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions:interface" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Content", "text": "(success: boolean, failureReason: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "print" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#printToPDF:member(1)", "docComment": "/**\n * Prints the window's web page as PDF.\n *\n * @param options - Options for printing to PDF.\n *\n * @returns A promise resolving with the generated PDF data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "printToPDF(options: " }, { "kind": "Reference", "text": "ElectronPrintToPDFOptions", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "printToPDF" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#redo:member(1)", "docComment": "/**\n * Executes the editing command `redo` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redo(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "redo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#reload:member(1)", "docComment": "/**\n * Reloads the current web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#reloadIgnoringCache:member(1)", "docComment": "/**\n * Reloads the current page and ignores the cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reloadIgnoringCache(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reloadIgnoringCache" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeInsertedCSS:member(1)", "docComment": "/**\n * Removes the inserted CSS from the current web page identified by its key.\n *\n * @param key - The key returned from `insertCSS`.\n *\n * @returns A promise that resolves if the removal was successful.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeInsertedCSS(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeInsertedCSS" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(1)", "docComment": "/**\n * Removes a previously registered `before-input-event` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'before-input-event'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", input: " }, { "kind": "Reference", "text": "ElectronInput", "canonicalReference": "obsidian-typings!ElectronInput:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(10)", "docComment": "/**\n * Removes a previously registered `devtools-focused` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'devtools-focused'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(11)", "docComment": "/**\n * Removes a previously registered `devtools-opened` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'devtools-opened'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(12)", "docComment": "/**\n * Removes a previously registered `devtools-reload-page` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'devtools-reload-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(13)", "docComment": "/**\n * Removes a previously registered `did-attach-webview` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-attach-webview'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(14)", "docComment": "/**\n * Removes a previously registered `did-change-theme-color` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-change-theme-color'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", color: null | string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(15)", "docComment": "/**\n * Removes a previously registered `did-create-window` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-create-window'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(window: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronDidCreateWindowDetails", "canonicalReference": "obsidian-typings!ElectronDidCreateWindowDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(16)", "docComment": "/**\n * Removes a previously registered `did-fail-load` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-fail-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 16, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(17)", "docComment": "/**\n * Removes a previously registered `did-fail-provisional-load` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-fail-provisional-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 17, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(18)", "docComment": "/**\n * Removes a previously registered `did-finish-load` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-finish-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 18, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(19)", "docComment": "/**\n * Removes a previously registered `did-frame-finish-load` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-frame-finish-load'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 19, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(2)", "docComment": "/**\n * Removes a previously registered `blur` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'blur'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(20)", "docComment": "/**\n * Removes a previously registered `did-frame-navigate` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-frame-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, httpResponseCode: number, httpStatusText: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 20, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(21)", "docComment": "/**\n * Removes a previously registered `did-navigate` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, httpResponseCode: number, httpStatusText: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 21, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(22)", "docComment": "/**\n * Removes a previously registered `did-navigate-in-page` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-navigate-in-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 22, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(23)", "docComment": "/**\n * Removes a previously registered `did-redirect-navigation` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-redirect-navigation'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 23, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(24)", "docComment": "/**\n * Removes a previously registered `did-start-loading` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-start-loading'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 24, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(25)", "docComment": "/**\n * Removes a previously registered `did-start-navigation` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-start-navigation'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 25, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(26)", "docComment": "/**\n * Removes a previously registered `did-stop-loading` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'did-stop-loading'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 26, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(27)", "docComment": "/**\n * Removes a previously registered `dom-ready` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'dom-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 27, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(28)", "docComment": "/**\n * Removes a previously registered `enter-html-full-screen` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'enter-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 28, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(29)", "docComment": "/**\n * Removes a previously registered `focus` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'focus'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 29, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(3)", "docComment": "/**\n * Removes a previously registered `certificate-error` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'certificate-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, error: string, certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ", callback: (isTrusted: boolean) => void, isMainFrame: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(30)", "docComment": "/**\n * Removes a previously registered `found-in-page` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'found-in-page'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", result: " }, { "kind": "Reference", "text": "ElectronResult", "canonicalReference": "obsidian-typings!ElectronResult:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 30, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(31)", "docComment": "/**\n * Removes a previously registered `frame-created` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'frame-created'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronFrameCreatedDetails", "canonicalReference": "obsidian-typings!ElectronFrameCreatedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 31, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(32)", "docComment": "/**\n * Removes a previously registered `ipc-message` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'ipc-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", channel: string, ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 32, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(33)", "docComment": "/**\n * Removes a previously registered `ipc-message-sync` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'ipc-message-sync'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", channel: string, ...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 33, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(34)", "docComment": "/**\n * Removes a previously registered `leave-html-full-screen` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'leave-html-full-screen'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 34, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(35)", "docComment": "/**\n * Removes a previously registered `login` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'login'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", authenticationResponseDetails: " }, { "kind": "Reference", "text": "ElectronAuthenticationResponseDetails", "canonicalReference": "obsidian-typings!ElectronAuthenticationResponseDetails:interface" }, { "kind": "Content", "text": ", authInfo: " }, { "kind": "Reference", "text": "ElectronAuthInfo", "canonicalReference": "obsidian-typings!ElectronAuthInfo:interface" }, { "kind": "Content", "text": ", callback: (username?: string, password?: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 35, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(36)", "docComment": "/**\n * Removes a previously registered `media-paused` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'media-paused'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 36, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(37)", "docComment": "/**\n * Removes a previously registered `media-started-playing` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'media-started-playing'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 37, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(38)", "docComment": "/**\n * Removes a previously registered `new-window` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'new-window'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronNewWindowWebContentsEvent", "canonicalReference": "obsidian-typings!ElectronNewWindowWebContentsEvent:interface" }, { "kind": "Content", "text": ", url: string, frameName: string, disposition: 'background-tab' | 'default' | 'foreground-tab' | 'new-window' | 'other' | 'save-to-disk', options: " }, { "kind": "Reference", "text": "BrowserWindowConstructorOptions", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions:interface" }, { "kind": "Content", "text": ", additionalFeatures: string[], referrer: " }, { "kind": "Reference", "text": "ElectronReferrer", "canonicalReference": "obsidian-typings!ElectronReferrer:interface" }, { "kind": "Content", "text": ", postBody: " }, { "kind": "Reference", "text": "ElectronPostBody", "canonicalReference": "obsidian-typings!ElectronPostBody:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 38, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(39)", "docComment": "/**\n * Removes a previously registered `page-favicon-updated` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'page-favicon-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", favicons: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 39, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(4)", "docComment": "/**\n * Removes a previously registered `console-message` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'console-message'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", level: number, message: string, line: number, sourceId: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(40)", "docComment": "/**\n * Removes a previously registered `page-title-updated` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'page-title-updated'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", title: string, explicitSet: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 40, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(41)", "docComment": "/**\n * Removes a previously registered `paint` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'paint'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", dirtyRect: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": ", image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 41, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(42)", "docComment": "/**\n * Removes a previously registered `plugin-crashed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'plugin-crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", name: string, version: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 42, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(43)", "docComment": "/**\n * Removes a previously registered `preferred-size-changed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'preferred-size-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preferredSize: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 43, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(44)", "docComment": "/**\n * Removes a previously registered `preload-error` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'preload-error'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preloadPath: string, error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 44, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(45)", "docComment": "/**\n * Removes a previously registered `render-process-gone` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'render-process-gone'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronRenderProcessGoneDetails", "canonicalReference": "obsidian-typings!ElectronRenderProcessGoneDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 45, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(46)", "docComment": "/**\n * Removes a previously registered `responsive` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'responsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 46, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(47)", "docComment": "/**\n * Removes a previously registered `select-bluetooth-device` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'select-bluetooth-device'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", devices: " }, { "kind": "Reference", "text": "ElectronBluetoothDevice", "canonicalReference": "obsidian-typings!ElectronBluetoothDevice:interface" }, { "kind": "Content", "text": "[], callback: (deviceId: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 47, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(48)", "docComment": "/**\n * Removes a previously registered `select-client-certificate` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'select-client-certificate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, certificateList: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": "[], callback: (certificate: " }, { "kind": "Reference", "text": "ElectronCertificate", "canonicalReference": "obsidian-typings!ElectronCertificate:interface" }, { "kind": "Content", "text": ") => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 48, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(49)", "docComment": "/**\n * Removes a previously registered `unresponsive` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'unresponsive'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 49, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(5)", "docComment": "/**\n * Removes a previously registered `context-menu` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'context-menu'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", params: " }, { "kind": "Reference", "text": "ElectronContextMenuParams", "canonicalReference": "obsidian-typings!ElectronContextMenuParams:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(50)", "docComment": "/**\n * Removes a previously registered `update-target-url` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'update-target-url'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 50, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(51)", "docComment": "/**\n * Removes a previously registered `will-attach-webview` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-attach-webview'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", webPreferences: " }, { "kind": "Reference", "text": "WebPreferences", "canonicalReference": "obsidian-typings!WebPreferences:interface" }, { "kind": "Content", "text": ", params: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 51, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(52)", "docComment": "/**\n * Removes a previously registered `will-navigate` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-navigate'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 52, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(53)", "docComment": "/**\n * Removes a previously registered `will-prevent-unload` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-prevent-unload'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 53, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(54)", "docComment": "/**\n * Removes a previously registered `will-redirect` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-redirect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", url: string, isInPlace: boolean, isMainFrame: boolean, frameProcessId: number, frameRoutingId: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 54, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(55)", "docComment": "/**\n * Removes a previously registered `zoom-changed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'zoom-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", zoomDirection: 'in' | 'out') => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 55, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(6)", "docComment": "/**\n * Removes a previously registered `crashed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'crashed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", killed: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(7)", "docComment": "/**\n * Removes a previously registered `cursor-changed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'cursor-changed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", type: string, image: " }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ", scale: number, size: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": ", hotspot: " }, { "kind": "Reference", "text": "ElectronPoint", "canonicalReference": "obsidian-typings!ElectronPoint:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 12 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(8)", "docComment": "/**\n * Removes a previously registered `destroyed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'destroyed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeListener:member(9)", "docComment": "/**\n * Removes a previously registered `devtools-closed` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This web contents instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'devtools-closed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#removeWorkSpace:member(1)", "docComment": "/**\n * Removes the specified path from the DevTools workspace.\n *\n * @param path - The path to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeWorkSpace(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeWorkSpace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#replace:member(1)", "docComment": "/**\n * Executes the editing command `replace` in the web page.\n *\n * @param text - The replacement text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replace(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "replace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#replaceMisspelling:member(1)", "docComment": "/**\n * Executes the editing command `replaceMisspelling` in the web page.\n *\n * @param text - The replacement text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceMisspelling(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "replaceMisspelling" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#savePage:member(1)", "docComment": "/**\n * Saves the current web page to the given path.\n *\n * @param fullPath - The absolute path to save the page to.\n *\n * @param saveType - The save type.\n *\n * @returns A promise that resolves if the page is saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "savePage(fullPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", saveType: " }, { "kind": "Content", "text": "'HTMLComplete' | 'HTMLOnly' | 'MHTML'" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fullPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "saveType", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "savePage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#selectAll:member(1)", "docComment": "/**\n * Executes the editing command `selectAll` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "selectAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#send:member(1)", "docComment": "/**\n * Sends an asynchronous message to the renderer process via `channel`, along with arguments.\n *\n * @param channel - The channel name.\n *\n * @param args - Arguments to serialize and send.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "send(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "send" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#sendInputEvent:member(1)", "docComment": "/**\n * Injects a trusted input event into the page, driving the same input pipeline a real user produces (unlike untrusted `dispatchEvent`, which CodeMirror and the CSS `:hover` engine ignore).\n *\n * @param inputEvent - The keyboard, mouse, or mouse wheel event to inject.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendInputEvent(inputEvent: " }, { "kind": "Reference", "text": "ElectronKeyboardInputEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardInputEvent:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronMouseInputEvent", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronMouseWheelInputEvent", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "inputEvent", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "sendInputEvent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#sendToFrame:member(1)", "docComment": "/**\n * Sends an asynchronous message to a specific frame in a renderer process via `channel`.\n *\n * @param frameId - The frame id, or a `[processId, frameId]` pair.\n *\n * @param channel - The channel name.\n *\n * @param args - Arguments to serialize and send.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendToFrame(frameId: " }, { "kind": "Content", "text": "[number, number] | number" }, { "kind": "Content", "text": ", channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "frameId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "sendToFrame" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#session:member", "docComment": "/**\n * The session used by this web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly session: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setAudioMuted:member(1)", "docComment": "/**\n * Mutes or unmutes the audio on the current web page.\n *\n * @param muted - Whether the audio should be muted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAudioMuted(muted: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "muted", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setAudioMuted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setBackgroundThrottling:member(1)", "docComment": "/**\n * Controls whether this web contents throttles animations and timers when backgrounded.\n *\n * @param allowed - Whether background throttling is allowed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBackgroundThrottling(allowed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "allowed", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setBackgroundThrottling" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setDevToolsWebContents:member(1)", "docComment": "/**\n * Uses the given web contents as the target to show DevTools.\n *\n * @param devToolsWebContents - The web contents to show DevTools in.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDevToolsWebContents(devToolsWebContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "devToolsWebContents", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setDevToolsWebContents" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setFrameRate:member(1)", "docComment": "/**\n * Sets the frame rate when offscreen rendering is enabled. Only values between 1 and 240 are accepted.\n *\n * @param fps - The frame rate in frames per second.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFrameRate(fps: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fps", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setFrameRate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setIgnoreMenuShortcuts:member(1)", "docComment": "/**\n * Ignores application menu shortcuts while this web contents is focused.\n *\n * @param ignore - Whether to ignore menu shortcuts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIgnoreMenuShortcuts(ignore: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ignore", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setIgnoreMenuShortcuts" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setImageAnimationPolicy:member(1)", "docComment": "/**\n * Sets the image animation policy for this web contents.\n *\n * @param policy - The image animation policy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setImageAnimationPolicy(policy: " }, { "kind": "Content", "text": "'animate' | 'animateOnce' | 'noAnimation'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "policy", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setImageAnimationPolicy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setUserAgent:member(1)", "docComment": "/**\n * Overrides the user agent for this web page.\n *\n * @param userAgent - The user agent to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUserAgent(userAgent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "userAgent", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setUserAgent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setVisualZoomLevelLimits:member(1)", "docComment": "/**\n * Sets the maximum and minimum pinch-to-zoom level.\n *\n * @param minimumLevel - The minimum zoom level.\n *\n * @param maximumLevel - The maximum zoom level.\n *\n * @returns A promise that resolves when the limits are set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setVisualZoomLevelLimits(minimumLevel: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", maximumLevel: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "minimumLevel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "maximumLevel", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setVisualZoomLevelLimits" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setWebRTCIPHandlingPolicy:member(1)", "docComment": "/**\n * Sets the WebRTC IP handling policy.\n *\n * @param policy - The WebRTC IP handling policy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setWebRTCIPHandlingPolicy(policy: " }, { "kind": "Content", "text": "'default_public_and_private_interfaces' | 'default_public_interface_only' | 'default' | 'disable_non_proxied_udp'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "policy", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setWebRTCIPHandlingPolicy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setWindowOpenHandler:member(1)", "docComment": "/**\n * Sets a handler called before a new window is requested by the renderer.\n *\n * @param handler - The handler that decides whether to allow or deny the new window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setWindowOpenHandler(handler: " }, { "kind": "Content", "text": "(details: " }, { "kind": "Reference", "text": "ElectronHandlerDetails", "canonicalReference": "obsidian-typings!ElectronHandlerDetails:interface" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "ElectronWindowOpenHandlerResponse", "canonicalReference": "obsidian-typings!ElectronWindowOpenHandlerResponse:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "name": "setWindowOpenHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setZoomFactor:member(1)", "docComment": "/**\n * Changes the zoom factor to the specified factor.\n *\n * @param factor - The zoom factor. Must be greater than `0.0`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setZoomFactor(factor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "factor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setZoomFactor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#setZoomLevel:member(1)", "docComment": "/**\n * Changes the zoom level to the specified level.\n *\n * @param level - The zoom level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setZoomLevel(level: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "level", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setZoomLevel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#showDefinitionForSelection:member(1)", "docComment": "/**\n * Shows a pop-up dictionary that searches the selected word on the page. Only available on macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showDefinitionForSelection(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showDefinitionForSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#startDrag:member(1)", "docComment": "/**\n * Sets the `item` as the dragging item for the current drag-drop operation.\n *\n * @param item - The item to drag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startDrag(item: " }, { "kind": "Reference", "text": "ElectronItem", "canonicalReference": "obsidian-typings!ElectronItem:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "startDrag" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#startPainting:member(1)", "docComment": "/**\n * Starts painting when offscreen rendering is enabled and not painting.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startPainting(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "startPainting" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#stop:member(1)", "docComment": "/**\n * Stops any pending navigation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stop(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stop" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#stopFindInPage:member(1)", "docComment": "/**\n * Stops any `findInPage` request for the web contents with the provided action.\n *\n * @param action - The action to take when stopping the find request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopFindInPage(action: " }, { "kind": "Content", "text": "'activateSelection' | 'clearSelection' | 'keepSelection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "stopFindInPage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#stopPainting:member(1)", "docComment": "/**\n * Stops painting when offscreen rendering is enabled and painting.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopPainting(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopPainting" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#takeHeapSnapshot:member(1)", "docComment": "/**\n * Takes a V8 heap snapshot and saves it to `filePath`.\n *\n * @param filePath - The path to save the heap snapshot to.\n *\n * @returns A promise resolving when the snapshot has been created.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "takeHeapSnapshot(filePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filePath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "takeHeapSnapshot" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#toggleDevTools:member(1)", "docComment": "/**\n * Toggles the developer tools.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleDevTools(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleDevTools" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#undo:member(1)", "docComment": "/**\n * Executes the editing command `undo` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undo(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "undo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContents#unselect:member(1)", "docComment": "/**\n * Executes the editing command `unselect` in the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unselect(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "unselect" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#userAgent:member", "docComment": "/**\n * The user agent for this web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userAgent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "userAgent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#zoomFactor:member", "docComment": "/**\n * The zoom factor for this web contents. The zoom factor is the zoom percent divided by 100.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomFactor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zoomFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContents#zoomLevel:member", "docComment": "/**\n * The zoom level for this web contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomLevel: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zoomLevel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebContentsDevToolsOptions:interface", "docComment": "/**\n * Options for opening developer tools.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebContentsDevToolsOptions " } ], "fileUrlPath": "src/electron/internals/ElectronWebContentsDevToolsOptions.d.ts", "releaseTag": "Public", "name": "ElectronWebContentsDevToolsOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsDevToolsOptions#activate:member", "docComment": "/**\n * Whether to bring the opened DevTools window to the foreground.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "activate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "activate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsDevToolsOptions#mode:member", "docComment": "/**\n * The mode to open DevTools in. Defaults to the last used dock state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode: " }, { "kind": "Content", "text": "'bottom' | 'detach' | 'left' | 'right' | 'undocked'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebContentsModule:interface", "docComment": "/**\n * The `webContents` module accessor exposed by Electron, providing static factory and lookup methods for `WebContents` instances.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebContentsModule " } ], "fileUrlPath": "src/electron/internals/ElectronWebContentsModule.d.ts", "releaseTag": "Public", "name": "ElectronWebContentsModule", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContentsModule#fromDevToolsTargetId:member(1)", "docComment": "/**\n * Looks up a `WebContents` instance based on its assigned Chrome DevTools Protocol TargetID.\n *\n * @param targetId - The Chrome DevTools Protocol TargetID to look up.\n *\n * @returns A `WebContents` instance with the given TargetID, or `undefined` if there is no `WebContents` associated with the given TargetID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromDevToolsTargetId(targetId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "targetId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "fromDevToolsTargetId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContentsModule#fromFrame:member(1)", "docComment": "/**\n * Looks up a `WebContents` instance based on a `WebFrameMain`.\n *\n * @param frame - The `WebFrameMain` to look up.\n *\n * @returns A `WebContents` instance with the given `WebFrameMain`, or `undefined` if there is no `WebContents` associated with the given `WebFrameMain`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromFrame(frame: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "frame", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "fromFrame" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContentsModule#fromId:member(1)", "docComment": "/**\n * Looks up a `WebContents` instance based on its ID.\n *\n * @param id - The ID to look up.\n *\n * @returns A `WebContents` instance with the given ID, or `undefined` if there is no `WebContents` associated with the given ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromId(id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "fromId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContentsModule#getAllWebContents:member(1)", "docComment": "/**\n * Returns an array of all `WebContents` instances. This will contain web contents for all windows, webviews, opened devtools, and devtools extension background pages.\n *\n * @returns An array of all `WebContents` instances.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAllWebContents(): " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAllWebContents" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebContentsModule#getFocusedWebContents:member(1)", "docComment": "/**\n * Returns the web contents that is focused in this application, otherwise returns `null`.\n *\n * @returns The focused `WebContents`, or `null` if none is focused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFocusedWebContents(): " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFocusedWebContents" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions:interface", "docComment": "/**\n * Options for printing a web page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebContentsPrintOptions " } ], "fileUrlPath": "src/electron/internals/ElectronWebContentsPrintOptions.d.ts", "releaseTag": "Public", "name": "ElectronWebContentsPrintOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#collate:member", "docComment": "/**\n * Whether the web page should be collated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "collate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#color:member", "docComment": "/**\n * Whether the printed web page will be in color or grayscale.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#copies:member", "docComment": "/**\n * The number of copies of the web page to print.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copies?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "copies", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#deviceName:member", "docComment": "/**\n * Set the printer device name to use. Must be the system-defined name and not the 'friendly' name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "deviceName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#dpi:member", "docComment": "/**\n * The DPI of the printed web page keyed by axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dpi?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, number>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "dpi", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#duplexMode:member", "docComment": "/**\n * Set the duplex mode of the printed web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "duplexMode?: " }, { "kind": "Content", "text": "'longEdge' | 'shortEdge' | 'simplex'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "duplexMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#footer:member", "docComment": "/**\n * String to be printed as page footer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "footer?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "footer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#header:member", "docComment": "/**\n * String to be printed as page header.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "header?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "header", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#landscape:member", "docComment": "/**\n * Whether the web page should be printed in landscape mode.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "landscape?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "landscape", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#margins:member", "docComment": "/**\n * The margins of the printed web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "margins?: " }, { "kind": "Reference", "text": "ElectronMargins", "canonicalReference": "obsidian-typings!ElectronMargins:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "margins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#pageRanges:member", "docComment": "/**\n * The page range to print. On macOS, only one range is honored.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageRanges?: " }, { "kind": "Reference", "text": "ElectronPageRanges", "canonicalReference": "obsidian-typings!ElectronPageRanges:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pageRanges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#pageSize:member", "docComment": "/**\n * The page size of the printed document. Can be `A3`, `A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an object containing `height` and `width`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageSize?: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pageSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#pagesPerSheet:member", "docComment": "/**\n * The number of pages to print per page sheet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pagesPerSheet?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pagesPerSheet", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#printBackground:member", "docComment": "/**\n * Prints the background color and image of the web page.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "printBackground?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "printBackground", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#scaleFactor:member", "docComment": "/**\n * The scale factor of the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebContentsPrintOptions#silent:member", "docComment": "/**\n * Don't ask the user for print settings.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "silent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "silent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface", "docComment": "/**\n * Electron WebFrame for customizing the rendering of the current web page in the renderer process.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebFrame " } ], "fileUrlPath": "src/electron/internals/ElectronWebFrame.d.ts", "releaseTag": "Public", "name": "ElectronWebFrame", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#clearCache:member(1)", "docComment": "/**\n * Attempts to free memory that is no longer being used (like images from a previous navigation).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearCache(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearCache" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#executeJavaScript:member(1)", "docComment": "/**\n * Evaluates `code` in the page. In the browser window some HTML APIs like `requestFullScreen` can only be invoked by a gesture from the user. Setting `userGesture` to `true` will remove this limitation.\n *\n * @param code - The code to evaluate.\n *\n * @param userGesture - Whether to treat the evaluation as being triggered by a user gesture.\n *\n * @param callback - Called with the result of the executed code. Modeled with `unknown` (the upstream `result` type is `any`).\n *\n * @returns A promise that resolves with the result of the executed code, or is rejected if execution throws or results in a rejected promise. Modeled with `unknown` (the upstream type is `any`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeJavaScript(code: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userGesture?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Content", "text": "(result: unknown, error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userGesture", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": true } ], "name": "executeJavaScript" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#executeJavaScriptInIsolatedWorld:member(1)", "docComment": "/**\n * Works like `executeJavaScript` but evaluates `scripts` in an isolated context. When the execution of a script fails, the returned promise will not reject and the `result` would be `undefined`.\n *\n * @param worldId - The id of the isolated world to run the scripts in.\n *\n * @param scripts - The scripts to evaluate.\n *\n * @param userGesture - Whether to treat the evaluation as being triggered by a user gesture.\n *\n * @param callback - Called with the result of the executed code. Modeled with `unknown` (the upstream `result` type is `any`).\n *\n * @returns A promise that resolves with the result of the executed code, or is rejected if execution could not start. Modeled with `unknown` (the upstream type is `any`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeJavaScriptInIsolatedWorld(worldId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", scripts: " }, { "kind": "Reference", "text": "ElectronWebSource", "canonicalReference": "obsidian-typings!ElectronWebSource:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", userGesture?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Content", "text": "(result: unknown, error: " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "worldId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "scripts", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "userGesture", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 11 }, "isOptional": true } ], "name": "executeJavaScriptInIsolatedWorld" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#findFrameByName:member(1)", "docComment": "/**\n * Returns a child of `webFrame` with the supplied `name`.\n *\n * @param name - The name of the child frame to find.\n *\n * @returns The child frame, or `null` if there is no such frame or if the frame is not in the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findFrameByName(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "findFrameByName" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#findFrameByRoutingId:member(1)", "docComment": "/**\n * Returns the frame that has the supplied `routingId`.\n *\n * @param routingId - The routing id of the frame to find.\n *\n * @returns The frame, or `null` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findFrameByRoutingId(routingId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "routingId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "findFrameByRoutingId" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#firstChild:member", "docComment": "/**\n * The first child frame of `webFrame`, or `null` if `webFrame` has no children or if the first child is not in the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly firstChild: " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "firstChild", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#getFrameForSelector:member(1)", "docComment": "/**\n * Returns the frame element in `webFrame`'s document selected by `selector`.\n *\n * @param selector - The CSS selector for the frame element.\n *\n * @returns The selected frame, or `null` if `selector` does not select a frame or if the frame is not in the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFrameForSelector(selector: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "selector", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFrameForSelector" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#getResourceUsage:member(1)", "docComment": "/**\n * Returns an object describing usage information of Blink's internal memory caches.\n *\n * @returns The resource usage information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getResourceUsage(): " }, { "kind": "Reference", "text": "ElectronResourceUsage", "canonicalReference": "obsidian-typings!ElectronResourceUsage:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getResourceUsage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#getWordSuggestions:member(1)", "docComment": "/**\n * Returns a list of suggested words for a given word.\n *\n * @param word - The word to get suggestions for.\n *\n * @returns The suggested words. Empty if the word is spelled correctly.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getWordSuggestions(word: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "word", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getWordSuggestions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#getZoomFactor:member(1)", "docComment": "/**\n * Returns the current zoom factor.\n *\n * @returns The current zoom factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getZoomFactor(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getZoomFactor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#getZoomLevel:member(1)", "docComment": "/**\n * Returns the current zoom level.\n *\n * @returns The current zoom level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getZoomLevel(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getZoomLevel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#insertCSS:member(1)", "docComment": "/**\n * Injects CSS into the current web page and returns a unique key for the inserted stylesheet.\n *\n * @param css - The CSS to insert.\n *\n * @param options - Options for inserting the CSS.\n *\n * @returns A key for the inserted CSS that can later be used to remove the CSS via `removeInsertedCSS(key)`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertCSS(css: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronInsertCSSOptions", "canonicalReference": "obsidian-typings!ElectronInsertCSSOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "css", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "insertCSS" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#insertText:member(1)", "docComment": "/**\n * Inserts `text` into the focused element.\n *\n * @param text - The text to insert.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertText(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "insertText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#isWordMisspelled:member(1)", "docComment": "/**\n * Returns whether the word is misspelled according to the built in spellchecker. If no dictionary is loaded, always returns `false`.\n *\n * @param word - The word to check.\n *\n * @returns Whether the word is misspelled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isWordMisspelled(word: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "word", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isWordMisspelled" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#nextSibling:member", "docComment": "/**\n * The next sibling frame, or `null` if `webFrame` is the last frame in its parent or if the next sibling is not in the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly nextSibling: " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "nextSibling", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#opener:member", "docComment": "/**\n * The frame which opened `webFrame`, or `null` if there is no opener or the opener is not in the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly opener: " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "opener", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#parent:member", "docComment": "/**\n * The parent frame of `webFrame`, or `null` if `webFrame` is top or the parent is not in the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly parent: " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#removeInsertedCSS:member(1)", "docComment": "/**\n * Removes the inserted CSS from the current web page. The stylesheet is identified by its key, which is returned from `insertCSS(css)`.\n *\n * @param key - The key of the inserted CSS to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeInsertedCSS(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeInsertedCSS" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#routingId:member", "docComment": "/**\n * The unique frame id in the current renderer process. Distinct `WebFrame` instances that refer to the same underlying frame will have the same `routingId`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly routingId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "routingId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#setIsolatedWorldInfo:member(1)", "docComment": "/**\n * Sets the security origin, content security policy and name of the isolated world. If the `csp` is specified, then the `securityOrigin` also has to be specified.\n *\n * @param worldId - The id of the isolated world to configure.\n *\n * @param info - The isolated world info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIsolatedWorldInfo(worldId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", info: " }, { "kind": "Reference", "text": "ElectronInfo", "canonicalReference": "obsidian-typings!ElectronInfo:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "worldId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setIsolatedWorldInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#setSpellCheckProvider:member(1)", "docComment": "/**\n * Sets a provider for spell checking in input fields and text areas. If you want to use this method you must disable the builtin spellchecker when you construct the window.\n *\n * @param language - The language to spell check.\n *\n * @param provider - The spell check provider.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSpellCheckProvider(language: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", provider: " }, { "kind": "Reference", "text": "ElectronProvider", "canonicalReference": "obsidian-typings!ElectronProvider:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "language", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "provider", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setSpellCheckProvider" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#setVisualZoomLevelLimits:member(1)", "docComment": "/**\n * Sets the maximum and minimum pinch-to-zoom level. Visual zoom is disabled by default in Electron.\n *\n * @param minimumLevel - The minimum pinch-to-zoom level.\n *\n * @param maximumLevel - The maximum pinch-to-zoom level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setVisualZoomLevelLimits(minimumLevel: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", maximumLevel: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "minimumLevel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "maximumLevel", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setVisualZoomLevelLimits" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#setZoomFactor:member(1)", "docComment": "/**\n * Changes the zoom factor to the specified factor. Zoom factor is zoom percent divided by 100, so 300% = `3.0`. The factor must be greater than `0.0`.\n *\n * @param factor - The zoom factor to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setZoomFactor(factor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "factor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setZoomFactor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#setZoomLevel:member(1)", "docComment": "/**\n * Changes the zoom level to the specified level. The original size is `0` and each increment above or below represents zooming 20% larger or smaller to default limits of 300% and 50% of original size, respectively.\n *\n * @param level - The zoom level to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setZoomLevel(level: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "level", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setZoomLevel" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrame#top:member", "docComment": "/**\n * The top frame in the frame hierarchy to which `webFrame` belongs, or `null` if the top frame is not in the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly top: " }, { "kind": "Reference", "text": "ElectronWebFrame", "canonicalReference": "obsidian-typings!ElectronWebFrame:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface", "docComment": "/**\n * A frame in the main process, representing a renderer frame.\n *\n * Note: The upstream `static fromId(processId, routingId)` factory cannot be expressed on a plain interface and is therefore omitted here.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebFrameMain " } ], "fileUrlPath": "src/electron/internals/ElectronWebFrameMain.d.ts", "releaseTag": "Public", "name": "ElectronWebFrameMain", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#addListener:member(1)", "docComment": "/**\n * Registers a listener for the `dom-ready` event, emitted when the document is loaded.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the document is loaded.\n *\n * @returns This frame instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'dom-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#executeJavaScript:member(1)", "docComment": "/**\n * Evaluates `code` in the page.\n *\n * @param code - The JavaScript code to execute.\n *\n * @param userGesture - Whether the execution should be treated as a user gesture.\n *\n * @returns A promise resolving with the result of the executed code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeJavaScript(code: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userGesture?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userGesture", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "executeJavaScript" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#frames:member", "docComment": "/**\n * A collection containing the direct descendents of this frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly frames: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "frames", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#framesInSubtree:member", "docComment": "/**\n * A collection containing every frame in the subtree of this frame, including itself.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly framesInSubtree: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "framesInSubtree", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#frameTreeNodeId:member", "docComment": "/**\n * The id of the frame's internal FrameTreeNode instance. Browser-global and uniquely identifies a frame that hosts content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly frameTreeNodeId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "frameTreeNodeId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#name:member", "docComment": "/**\n * The frame name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#on:member(1)", "docComment": "/**\n * Registers a listener for the `dom-ready` event, emitted when the document is loaded.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the document is loaded.\n *\n * @returns This frame instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'dom-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#once:member(1)", "docComment": "/**\n * Registers a one-time listener for the `dom-ready` event.\n *\n * @param event - The event name.\n *\n * @param listener - Called when the document is loaded.\n *\n * @returns This frame instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'dom-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#osProcessId:member", "docComment": "/**\n * The operating system `pid` of the process which owns this frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly osProcessId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "osProcessId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#parent:member", "docComment": "/**\n * The parent frame, or `null` if this is the top frame in the frame hierarchy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly parent: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#postMessage:member(1)", "docComment": "/**\n * Sends a message to the renderer process, optionally transferring ownership of `MessagePortMain` objects.\n *\n * @param channel - The channel name.\n *\n * @param message - The message to send.\n *\n * @param transfer - Message ports whose ownership is transferred with the message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postMessage(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", message: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", transfer?: " }, { "kind": "Reference", "text": "ElectronMessagePortMain", "canonicalReference": "obsidian-typings!ElectronMessagePortMain:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "transfer", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": true } ], "name": "postMessage" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#processId:member", "docComment": "/**\n * The Chromium internal `pid` of the process which owns this frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly processId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "processId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#reload:member(1)", "docComment": "/**\n * Reloads the frame.\n *\n * @returns Whether the reload was initiated successfully. Only `false` when the frame has no history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reload(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#removeListener:member(1)", "docComment": "/**\n * Removes a previously registered `dom-ready` event listener.\n *\n * @param event - The event name.\n *\n * @param listener - The listener to remove.\n *\n * @returns This frame instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'dom-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#routingId:member", "docComment": "/**\n * The unique frame id in the current renderer process.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly routingId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "routingId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#send:member(1)", "docComment": "/**\n * Sends an asynchronous message to the renderer process via `channel`, along with arguments.\n *\n * @param channel - The channel name.\n *\n * @param args - Arguments to serialize and send.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "send(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "send" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#top:member", "docComment": "/**\n * The top frame in the frame hierarchy to which this frame belongs, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly top: " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#url:member", "docComment": "/**\n * The current URL of the frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMain#visibilityState:member", "docComment": "/**\n * The visibility state of the frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly visibilityState: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "visibilityState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebFrameMainModule:interface", "docComment": "/**\n * The `webFrameMain` module accessor exposed on {@link ElectronRemote}, distinct from the {@link ElectronWebFrameMain} class it returns.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebFrameMainModule " } ], "fileUrlPath": "src/electron/internals/ElectronWebFrameMainModule.d.ts", "releaseTag": "Public", "name": "ElectronWebFrameMainModule", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebFrameMainModule#fromId:member(1)", "docComment": "/**\n * Returns the frame with the given process and routing ids, or `undefined` if none is found.\n *\n * @param processId - The process id.\n *\n * @param routingId - The routing id.\n *\n * @returns The matching frame, or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromId(processId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", routingId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronWebFrameMain", "canonicalReference": "obsidian-typings!ElectronWebFrameMain:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "processId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "routingId", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "fromId" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebRequest:interface", "docComment": "/**\n * Intercepts and observes a session's network requests at various life-cycle stages.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebRequest " } ], "fileUrlPath": "src/electron/internals/ElectronWebRequest.d.ts", "releaseTag": "Public", "name": "ElectronWebRequest", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onBeforeRedirect:member(1)", "docComment": "/**\n * Registers a listener called when a server initiated redirect is about to occur, filtered by `filter`.\n *\n * @param filter - The filter narrowing which requests are observed.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onBeforeRedirect(filter: " }, { "kind": "Reference", "text": "ElectronWebRequestFilter", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnBeforeRedirectListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "onBeforeRedirect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onBeforeRedirect:member(2)", "docComment": "/**\n * Registers a listener called when a server initiated redirect is about to occur.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onBeforeRedirect(listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnBeforeRedirectListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnBeforeRedirectListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "onBeforeRedirect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onBeforeRequest:member(1)", "docComment": "/**\n * Registers a listener called when a request is about to occur, filtered by `filter`.\n *\n * @param filter - The filter narrowing which requests are observed.\n *\n * @param listener - Called with the request details and a response callback, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onBeforeRequest(filter: " }, { "kind": "Reference", "text": "ElectronWebRequestFilter", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnBeforeRequestListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronResponse", "canonicalReference": "obsidian-typings!ElectronResponse:interface" }, { "kind": "Content", "text": ") => void) => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "onBeforeRequest" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onBeforeRequest:member(2)", "docComment": "/**\n * Registers a listener called when a request is about to occur.\n *\n * @param listener - Called with the request details and a response callback, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onBeforeRequest(listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnBeforeRequestListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnBeforeRequestListenerDetails:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronResponse", "canonicalReference": "obsidian-typings!ElectronResponse:interface" }, { "kind": "Content", "text": ") => void) => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "onBeforeRequest" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onBeforeSendHeaders:member(1)", "docComment": "/**\n * Registers a listener called before sending an HTTP request, once the request headers are available, filtered by `filter`.\n *\n * @param filter - The filter narrowing which requests are observed.\n *\n * @param listener - Called with the request details and a response callback, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onBeforeSendHeaders(filter: " }, { "kind": "Reference", "text": "ElectronWebRequestFilter", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnBeforeSendHeadersListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails:interface" }, { "kind": "Content", "text": ", callback: (beforeSendResponse: " }, { "kind": "Reference", "text": "ElectronBeforeSendResponse", "canonicalReference": "obsidian-typings!ElectronBeforeSendResponse:interface" }, { "kind": "Content", "text": ") => void) => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "onBeforeSendHeaders" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onBeforeSendHeaders:member(2)", "docComment": "/**\n * Registers a listener called before sending an HTTP request, once the request headers are available.\n *\n * @param listener - Called with the request details and a response callback, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onBeforeSendHeaders(listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnBeforeSendHeadersListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnBeforeSendHeadersListenerDetails:interface" }, { "kind": "Content", "text": ", callback: (beforeSendResponse: " }, { "kind": "Reference", "text": "ElectronBeforeSendResponse", "canonicalReference": "obsidian-typings!ElectronBeforeSendResponse:interface" }, { "kind": "Content", "text": ") => void) => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "onBeforeSendHeaders" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onCompleted:member(1)", "docComment": "/**\n * Registers a listener called when a request is completed, filtered by `filter`.\n *\n * @param filter - The filter narrowing which requests are observed.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCompleted(filter: " }, { "kind": "Reference", "text": "ElectronWebRequestFilter", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnCompletedListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "onCompleted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onCompleted:member(2)", "docComment": "/**\n * Registers a listener called when a request is completed.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCompleted(listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnCompletedListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnCompletedListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "onCompleted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onErrorOccurred:member(1)", "docComment": "/**\n * Registers a listener called when an error occurs, filtered by `filter`.\n *\n * @param filter - The filter narrowing which requests are observed.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onErrorOccurred(filter: " }, { "kind": "Reference", "text": "ElectronWebRequestFilter", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnErrorOccurredListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "onErrorOccurred" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onErrorOccurred:member(2)", "docComment": "/**\n * Registers a listener called when an error occurs.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onErrorOccurred(listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnErrorOccurredListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnErrorOccurredListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "onErrorOccurred" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onHeadersReceived:member(1)", "docComment": "/**\n * Registers a listener called when HTTP response headers of a request have been received, filtered by `filter`.\n *\n * @param filter - The filter narrowing which requests are observed.\n *\n * @param listener - Called with the request details and a response callback, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onHeadersReceived(filter: " }, { "kind": "Reference", "text": "ElectronWebRequestFilter", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnHeadersReceivedListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails:interface" }, { "kind": "Content", "text": ", callback: (headersReceivedResponse: " }, { "kind": "Reference", "text": "ElectronHeadersReceivedResponse", "canonicalReference": "obsidian-typings!ElectronHeadersReceivedResponse:interface" }, { "kind": "Content", "text": ") => void) => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "onHeadersReceived" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onHeadersReceived:member(2)", "docComment": "/**\n * Registers a listener called when HTTP response headers of a request have been received.\n *\n * @param listener - Called with the request details and a response callback, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onHeadersReceived(listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnHeadersReceivedListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnHeadersReceivedListenerDetails:interface" }, { "kind": "Content", "text": ", callback: (headersReceivedResponse: " }, { "kind": "Reference", "text": "ElectronHeadersReceivedResponse", "canonicalReference": "obsidian-typings!ElectronHeadersReceivedResponse:interface" }, { "kind": "Content", "text": ") => void) => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "onHeadersReceived" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onResponseStarted:member(1)", "docComment": "/**\n * Registers a listener called when the first byte of the response body is received, filtered by `filter`.\n *\n * @param filter - The filter narrowing which requests are observed.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResponseStarted(filter: " }, { "kind": "Reference", "text": "ElectronWebRequestFilter", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnResponseStartedListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "onResponseStarted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onResponseStarted:member(2)", "docComment": "/**\n * Registers a listener called when the first byte of the response body is received.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResponseStarted(listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnResponseStartedListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnResponseStartedListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "onResponseStarted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onSendHeaders:member(1)", "docComment": "/**\n * Registers a listener called just before a request is going to be sent to the server, filtered by `filter`.\n *\n * @param filter - The filter narrowing which requests are observed.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSendHeaders(filter: " }, { "kind": "Reference", "text": "ElectronWebRequestFilter", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnSendHeadersListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "onSendHeaders" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebRequest#onSendHeaders:member(2)", "docComment": "/**\n * Registers a listener called just before a request is going to be sent to the server.\n *\n * @param listener - Called with the request details, or `null` to remove the listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSendHeaders(listener: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronOnSendHeadersListenerDetails", "canonicalReference": "obsidian-typings!ElectronOnSendHeadersListenerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "onSendHeaders" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter:interface", "docComment": "/**\n * Filter used to narrow which requests a web-request listener receives.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebRequestFilter " } ], "fileUrlPath": "src/electron/internals/ElectronWebRequestFilter.d.ts", "releaseTag": "Public", "name": "ElectronWebRequestFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebRequestFilter#urls:member", "docComment": "/**\n * Array of URL patterns that will be used to filter out the requests that do not match the URL patterns.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "urls: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "urls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebSource:interface", "docComment": "/**\n * A script source to evaluate in an isolated world.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebSource " } ], "fileUrlPath": "src/electron/internals/ElectronWebSource.d.ts", "releaseTag": "Public", "name": "ElectronWebSource", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebSource#code:member", "docComment": "/**\n * The JavaScript code to evaluate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "code: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "code", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebSource#url:member", "docComment": "/**\n * The URL associated with the code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebviewTag:interface", "docComment": "/**\n * Electron WebviewTag for embedding external web content in the application.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebviewTag extends " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/ElectronWebviewTag.d.ts", "releaseTag": "Public", "name": "ElectronWebviewTag", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#addEventListener:member(1)", "docComment": "/**\n * Registers an event listener.\n *\n * @param type - The event type.\n *\n * @param listener - The event handler.\n *\n * @param options - Listener options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addEventListener(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Reference", "text": "EventListenerOrEventListenerObject", "canonicalReference": "!EventListenerOrEventListenerObject:type" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "AddEventListenerOptions", "canonicalReference": "!AddEventListenerOptions:interface" }, { "kind": "Content", "text": " | boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": true } ], "name": "addEventListener" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#allowpopups:member", "docComment": "/**\n * Whether to allow popups.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowpopups: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "allowpopups", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#canGoBack:member(1)", "docComment": "/**\n * Returns whether the webview can navigate back.\n *\n * @returns Whether the webview can go back.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canGoBack(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canGoBack" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#canGoForward:member(1)", "docComment": "/**\n * Returns whether the webview can navigate forward.\n *\n * @returns Whether the webview can go forward.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canGoForward(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "canGoForward" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#canGoToOffset:member(1)", "docComment": "/**\n * Returns whether the webview can navigate to the given offset.\n *\n * @param offset - The history offset.\n *\n * @returns Whether the webview can go to the offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canGoToOffset(offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "offset", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "canGoToOffset" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#capturePage:member(1)", "docComment": "/**\n * Captures a snapshot of the page.\n *\n * @param rect - The area to capture. Omitting it captures the whole visible page.\n *\n * @returns The captured image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "capturePage(rect?: " }, { "kind": "Reference", "text": "ElectronRectangle", "canonicalReference": "obsidian-typings!ElectronRectangle:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronNativeImage", "canonicalReference": "obsidian-typings!ElectronNativeImage:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "capturePage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#clearHistory:member(1)", "docComment": "/**\n * Clears the navigation history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearHistory(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearHistory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#closeDevTools:member(1)", "docComment": "/**\n * Closes the developer tools.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeDevTools(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "closeDevTools" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#copy:member(1)", "docComment": "/**\n * Copies the selected text to the clipboard.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "copy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#cut:member(1)", "docComment": "/**\n * Cuts the selected text to the clipboard.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cut(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cut" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#delete:member(1)", "docComment": "/**\n * Deletes the selected text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "delete(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "delete" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#disableblinkfeatures:member", "docComment": "/**\n * The Blink features to disable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableblinkfeatures: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disableblinkfeatures", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#disablewebsecurity:member", "docComment": "/**\n * Whether to disable web security.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disablewebsecurity: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disablewebsecurity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#downloadURL:member(1)", "docComment": "/**\n * Initiates a download of the resource at the given URL without navigating.\n *\n * @param url - The URL to download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadURL(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "downloadURL" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#enableblinkfeatures:member", "docComment": "/**\n * The Blink features to enable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableblinkfeatures: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableblinkfeatures", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#executeJavaScript:member(1)", "docComment": "/**\n * Evaluates JavaScript code in the context of the page.\n *\n * @param code - The JavaScript code to execute.\n *\n * @param userGesture - Whether the execution should be treated as a user gesture.\n *\n * @returns The result of the evaluated code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeJavaScript(code: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", userGesture?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "userGesture", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "executeJavaScript" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#findInPage:member(1)", "docComment": "/**\n * Starts finding text in the page.\n *\n * @param text - The text to find.\n *\n * @param options - Find options including `forward`, `findNext`, and `matchCase`.\n *\n * @returns The request id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findInPage(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronWebviewTagFindInPageOptions", "canonicalReference": "obsidian-typings!ElectronWebviewTagFindInPageOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "findInPage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#getTitle:member(1)", "docComment": "/**\n * Returns the title of the page.\n *\n * @returns The page title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTitle(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTitle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#getURL:member(1)", "docComment": "/**\n * Returns the URL of the current page.\n *\n * @returns The current URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getURL(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#getUserAgent:member(1)", "docComment": "/**\n * Returns the user agent string.\n *\n * @returns The user agent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getUserAgent(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getUserAgent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#getWebContentsId:member(1)", "docComment": "/**\n * Returns the web contents id.\n *\n * @returns The web contents id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getWebContentsId(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWebContentsId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#getZoomFactor:member(1)", "docComment": "/**\n * Returns the current zoom factor.\n *\n * @returns The zoom factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getZoomFactor(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getZoomFactor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#getZoomLevel:member(1)", "docComment": "/**\n * Returns the current zoom level.\n *\n * @returns The zoom level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getZoomLevel(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getZoomLevel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#goBack:member(1)", "docComment": "/**\n * Navigates back.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goBack(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "goBack" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#goForward:member(1)", "docComment": "/**\n * Navigates forward.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goForward(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "goForward" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#goToIndex:member(1)", "docComment": "/**\n * Navigates to the specified history index.\n *\n * @param index - The history index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goToIndex(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "goToIndex" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#goToOffset:member(1)", "docComment": "/**\n * Navigates to the specified history offset.\n *\n * @param offset - The history offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goToOffset(offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "offset", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "goToOffset" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#httpreferrer:member", "docComment": "/**\n * The HTTP referrer URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "httpreferrer: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "httpreferrer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#insertCSS:member(1)", "docComment": "/**\n * Injects CSS into the page.\n *\n * @param css - The CSS string to inject.\n *\n * @returns A key that can be used to remove the CSS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertCSS(css: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "css", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "insertCSS" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#insertText:member(1)", "docComment": "/**\n * Inserts text at the current cursor position.\n *\n * @param text - The text to insert.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertText(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "insertText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#inspectElement:member(1)", "docComment": "/**\n * Inspects the element at the given position.\n *\n * @param x - The x coordinate.\n *\n * @param y - The y coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inspectElement(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "inspectElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#inspectServiceWorker:member(1)", "docComment": "/**\n * Opens the developer tools for the service worker context present in the guest page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inspectServiceWorker(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "inspectServiceWorker" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#inspectSharedWorker:member(1)", "docComment": "/**\n * Opens the developer tools for the shared worker context present in the guest page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inspectSharedWorker(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "inspectSharedWorker" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#isAudioMuted:member(1)", "docComment": "/**\n * Returns whether the page audio is muted.\n *\n * @returns Whether audio is muted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAudioMuted(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isAudioMuted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#isCrashed:member(1)", "docComment": "/**\n * Returns whether the page renderer process has crashed.\n *\n * @returns Whether the page has crashed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isCrashed(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isCrashed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#isCurrentlyAudible:member(1)", "docComment": "/**\n * Returns whether the page is currently producing audio.\n *\n * @returns Whether the page is audible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isCurrentlyAudible(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isCurrentlyAudible" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#isDevToolsFocused:member(1)", "docComment": "/**\n * Returns whether the developer tools are focused.\n *\n * @returns Whether DevTools are focused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDevToolsFocused(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isDevToolsFocused" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#isDevToolsOpened:member(1)", "docComment": "/**\n * Returns whether the developer tools are opened.\n *\n * @returns Whether DevTools are opened.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDevToolsOpened(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isDevToolsOpened" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#isLoading:member(1)", "docComment": "/**\n * Returns whether the page is loading resources.\n *\n * @returns Whether the page is loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isLoading(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isLoading" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#isLoadingMainFrame:member(1)", "docComment": "/**\n * Returns whether the main frame of the page is loading.\n *\n * @returns Whether the main frame is loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isLoadingMainFrame(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isLoadingMainFrame" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#isWaitingForResponse:member(1)", "docComment": "/**\n * Returns whether the page is waiting for a first response.\n *\n * @returns Whether the page is waiting for a response.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isWaitingForResponse(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isWaitingForResponse" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#loadURL:member(1)", "docComment": "/**\n * Loads the given URL.\n *\n * @param url - The URL to load. Must contain the protocol prefix, e.g. `http://` or `file://`.\n *\n * @param options - Options for loading the URL including `httpReferrer`, `userAgent`, and `extraHeaders`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadURL(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronBrowserWindowLoadURLOptions", "canonicalReference": "obsidian-typings!ElectronBrowserWindowLoadURLOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadURL" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#nodeintegration:member", "docComment": "/**\n * Whether to enable Node.js integration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeintegration: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodeintegration", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#nodeintegrationinsubframes:member", "docComment": "/**\n * Whether to enable Node.js integration in sub-frames.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeintegrationinsubframes: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodeintegrationinsubframes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#openDevTools:member(1)", "docComment": "/**\n * Opens the developer tools.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openDevTools(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "openDevTools" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#partition:member", "docComment": "/**\n * The session partition string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "partition: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "partition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#paste:member(1)", "docComment": "/**\n * Pastes from the clipboard.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paste(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "paste" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#pasteAndMatchStyle:member(1)", "docComment": "/**\n * Pastes and matches the style of the current text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pasteAndMatchStyle(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "pasteAndMatchStyle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#plugins:member", "docComment": "/**\n * Whether to enable plugins.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugins: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#preload:member", "docComment": "/**\n * The path to the preload script.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preload: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "preload", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#print:member(1)", "docComment": "/**\n * Prints the page.\n *\n * @param options - Print options including `silent`, `printBackground`, and `deviceName`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "print(options?: " }, { "kind": "Reference", "text": "ElectronWebviewTagPrintOptions", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "print" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#printToPDF:member(1)", "docComment": "/**\n * Prints the page as a PDF.\n *\n * @param options - The PDF print options.\n *\n * @returns The generated PDF data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "printToPDF(options: " }, { "kind": "Reference", "text": "ElectronPrintToPDFOptions", "canonicalReference": "obsidian-typings!ElectronPrintToPDFOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Uint8Array", "canonicalReference": "!Uint8Array:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "printToPDF" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#redo:member(1)", "docComment": "/**\n * Redoes the last undone action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redo(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "redo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#reload:member(1)", "docComment": "/**\n * Reloads the page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#reloadIgnoringCache:member(1)", "docComment": "/**\n * Reloads the page ignoring the cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reloadIgnoringCache(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reloadIgnoringCache" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#removeEventListener:member(1)", "docComment": "/**\n * Removes an event listener.\n *\n * @param type - The event type.\n *\n * @param listener - The event handler.\n *\n * @param options - Listener options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeEventListener(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Reference", "text": "EventListenerOrEventListenerObject", "canonicalReference": "!EventListenerOrEventListenerObject:type" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "EventListenerOptions", "canonicalReference": "!EventListenerOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": true } ], "name": "removeEventListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#removeInsertedCSS:member(1)", "docComment": "/**\n * Removes previously injected CSS.\n *\n * @param key - The key of the CSS to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeInsertedCSS(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeInsertedCSS" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#replace:member(1)", "docComment": "/**\n * Replaces the current text with the given text.\n *\n * @param text - The replacement text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replace(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "replace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#replaceMisspelling:member(1)", "docComment": "/**\n * Replaces the misspelled word with the given text.\n *\n * @param text - The replacement text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceMisspelling(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "replaceMisspelling" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#selectAll:member(1)", "docComment": "/**\n * Selects all text on the page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "selectAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#send:member(1)", "docComment": "/**\n * Sends an asynchronous message to the renderer process.\n *\n * @param channel - The IPC channel name.\n *\n * @param args - Arguments to send.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "send(channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "send" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#sendInputEvent:member(1)", "docComment": "/**\n * Sends an input event to the page.\n *\n * @param inputEvent - The keyboard, mouse, or mouse wheel event to inject.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendInputEvent(inputEvent: " }, { "kind": "Reference", "text": "ElectronKeyboardInputEvent", "canonicalReference": "obsidian-typings!ElectronKeyboardInputEvent:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronMouseInputEvent", "canonicalReference": "obsidian-typings!ElectronMouseInputEvent:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ElectronMouseWheelInputEvent", "canonicalReference": "obsidian-typings!ElectronMouseWheelInputEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "inputEvent", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "sendInputEvent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#sendToFrame:member(1)", "docComment": "/**\n * Sends a message to a specific frame in the renderer process.\n *\n * @param frameId - The frame identifier tuple.\n *\n * @param channel - The IPC channel name.\n *\n * @param args - Arguments to send.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sendToFrame(frameId: " }, { "kind": "Content", "text": "[number, number]" }, { "kind": "Content", "text": ", channel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "frameId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "channel", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "sendToFrame" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#setAudioMuted:member(1)", "docComment": "/**\n * Sets whether the page audio is muted.\n *\n * @param muted - Whether to mute audio.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAudioMuted(muted: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "muted", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setAudioMuted" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#setUserAgent:member(1)", "docComment": "/**\n * Sets the user agent string.\n *\n * @param userAgent - The user agent to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUserAgent(userAgent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "userAgent", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setUserAgent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#setVisualZoomLevelLimits:member(1)", "docComment": "/**\n * Sets the maximum and minimum pinch-to-zoom level.\n *\n * @param minimumLevel - The minimum zoom level.\n *\n * @param maximumLevel - The maximum zoom level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setVisualZoomLevelLimits(minimumLevel: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", maximumLevel: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "minimumLevel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "maximumLevel", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setVisualZoomLevelLimits" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#setZoomFactor:member(1)", "docComment": "/**\n * Sets the zoom factor of the page.\n *\n * @param factor - The zoom factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setZoomFactor(factor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "factor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setZoomFactor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#setZoomLevel:member(1)", "docComment": "/**\n * Sets the zoom level of the page.\n *\n * @param level - The zoom level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setZoomLevel(level: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "level", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setZoomLevel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#showDefinitionForSelection:member(1)", "docComment": "/**\n * Shows a pop-up dictionary that searches the selected word on the page.\n *\n * @remarks\n *\n * Only available on macOS (`darwin`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showDefinitionForSelection(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showDefinitionForSelection" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#src:member", "docComment": "/**\n * The URL to load.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "src: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "src", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#stop:member(1)", "docComment": "/**\n * Stops loading the page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stop(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stop" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#stopFindInPage:member(1)", "docComment": "/**\n * Stops the find in page request.\n *\n * @param action - The action to take when stopping.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopFindInPage(action: " }, { "kind": "Content", "text": "'activateSelection' | 'clearSelection' | 'keepSelection'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "stopFindInPage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#undo:member(1)", "docComment": "/**\n * Undoes the last action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "undo(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "undo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#unselect:member(1)", "docComment": "/**\n * Clears the current selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unselect(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "unselect" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#useragent:member", "docComment": "/**\n * The user agent string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useragent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "useragent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTag#webpreferences:member", "docComment": "/**\n * The web preferences string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webpreferences: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webpreferences", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebviewTagFindInPageOptions:interface", "docComment": "/**\n * Options for finding text in a webview page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebviewTagFindInPageOptions " } ], "fileUrlPath": "src/electron/internals/ElectronWebviewTagFindInPageOptions.d.ts", "releaseTag": "Public", "name": "ElectronWebviewTagFindInPageOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagFindInPageOptions#findNext:member", "docComment": "/**\n * Whether to begin a new text finding session with this request. Should be `true` for initial requests, and `false` for follow-up requests.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findNext?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "findNext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagFindInPageOptions#forward:member", "docComment": "/**\n * Whether to search forward or backward.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forward?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "forward", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagFindInPageOptions#matchCase:member", "docComment": "/**\n * Whether the search should be case-sensitive.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "matchCase?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "matchCase", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions:interface", "docComment": "/**\n * Options for printing a webview page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWebviewTagPrintOptions " } ], "fileUrlPath": "src/electron/internals/ElectronWebviewTagPrintOptions.d.ts", "releaseTag": "Public", "name": "ElectronWebviewTagPrintOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#collate:member", "docComment": "/**\n * Whether the web page should be collated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "collate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#color:member", "docComment": "/**\n * Whether the printed web page will be in color or grayscale.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#copies:member", "docComment": "/**\n * The number of copies of the web page to print.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copies?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "copies", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#deviceName:member", "docComment": "/**\n * The name of the printer device to use. Must be the system-defined name and not the 'friendly' name, e.g. `Brother_QL_820NWB` and not `Brother QL-820NWB`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deviceName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "deviceName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#dpi:member", "docComment": "/**\n * The DPI settings of the printed web page, keyed by axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dpi?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, number>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "dpi", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#duplexMode:member", "docComment": "/**\n * The duplex mode of the printed web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "duplexMode?: " }, { "kind": "Content", "text": "'longEdge' | 'shortEdge' | 'simplex'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "duplexMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#footer:member", "docComment": "/**\n * The string to be printed as the page footer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "footer?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "footer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#header:member", "docComment": "/**\n * The string to be printed as the page header.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "header?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "header", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#landscape:member", "docComment": "/**\n * Whether the web page should be printed in landscape mode.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "landscape?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "landscape", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#margins:member", "docComment": "/**\n * The margins of the printed web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "margins?: " }, { "kind": "Reference", "text": "ElectronMargins", "canonicalReference": "obsidian-typings!ElectronMargins:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "margins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#pageRanges:member", "docComment": "/**\n * The page range to print.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageRanges?: " }, { "kind": "Reference", "text": "ElectronPageRanges", "canonicalReference": "obsidian-typings!ElectronPageRanges:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pageRanges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#pageSize:member", "docComment": "/**\n * The page size of the printed document. Can be `A3`, `A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an object containing `height` and `width`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageSize?: " }, { "kind": "Reference", "text": "ElectronSize", "canonicalReference": "obsidian-typings!ElectronSize:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pageSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#pagesPerSheet:member", "docComment": "/**\n * The number of pages to print per page sheet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pagesPerSheet?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pagesPerSheet", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#printBackground:member", "docComment": "/**\n * Whether to print the background color and image of the web page.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "printBackground?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "printBackground", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#scaleFactor:member", "docComment": "/**\n * The scale factor of the web page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scaleFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWebviewTagPrintOptions#silent:member", "docComment": "/**\n * Whether to print silently without asking the user for print settings.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "silent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "silent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWillResizeDetails:interface", "docComment": "/**\n * Details about a pending window resize, emitted with the `will-resize` event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWillResizeDetails " } ], "fileUrlPath": "src/electron/internals/ElectronWillResizeDetails.d.ts", "releaseTag": "Public", "name": "ElectronWillResizeDetails", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWillResizeDetails#edge:member", "docComment": "/**\n * The edge of the window being dragged for resizing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "edge: " }, { "kind": "Content", "text": "'bottom-left' | 'bottom-right' | 'bottom' | 'left' | 'right' | 'top-left' | 'top-right'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "edge", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWindow:interface", "docComment": "/**\n * Extended Electron BrowserWindow with internal properties.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWindow extends " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/ElectronWindow.d.ts", "releaseTag": "Public", "name": "ElectronWindow", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWindow#_browserViews:member", "docComment": "/**\n * Internal browser views attached to the window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_browserViews: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_browserViews", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWindow#_events:member", "docComment": "/**\n * Internal event handlers map.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_events: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_events", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWindow#_eventsCount:member", "docComment": "/**\n * Number of registered event handlers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_eventsCount: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_eventsCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWindow#devToolsWebContents:member", "docComment": "/**\n * Web contents for the developer tools panel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "devToolsWebContents: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "devToolsWebContents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ElectronWindowOpenHandlerResponse:interface", "docComment": "/**\n * Response returned by the {@link ElectronWebContents.setWindowOpenHandler} handler, deciding whether a requested new window is allowed or denied.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElectronWindowOpenHandlerResponse " } ], "fileUrlPath": "src/electron/internals/ElectronWindowOpenHandlerResponse.d.ts", "releaseTag": "Public", "name": "ElectronWindowOpenHandlerResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWindowOpenHandlerResponse#action:member", "docComment": "/**\n * Whether to allow or deny creating the new window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "action: " }, { "kind": "Content", "text": "'allow' | 'deny'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "action", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ElectronWindowOpenHandlerResponse#overrideBrowserWindowOptions:member", "docComment": "/**\n * Overrides passed to the created {@link ElectronBrowserWindow}. Only used when `action` is `'allow'`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overrideBrowserWindowOptions?: " }, { "kind": "Reference", "text": "BrowserWindowConstructorOptions", "canonicalReference": "obsidian-typings!BrowserWindowConstructorOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "overrideBrowserWindowOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface", "docComment": "/**\n * A component that renders an embedded audio file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedAudioComponent extends " }, { "kind": "Reference", "text": "EmbedComponent", "canonicalReference": "obsidian-typings!EmbedComponent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedAudioComponent.d.ts", "releaseTag": "Public", "name": "EmbedAudioComponent", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedCanvasComponent:interface", "docComment": "/**\n * A component that renders an embedded canvas file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedCanvasComponent extends " }, { "kind": "Reference", "text": "EmbedComponent", "canonicalReference": "obsidian-typings!EmbedComponent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedCanvasComponent.d.ts", "releaseTag": "Public", "name": "EmbedCanvasComponent", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedComponent:interface", "docComment": "/**\n * The component that renders the embedded file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedComponent extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedComponent.d.ts", "releaseTag": "Public", "name": "EmbedComponent", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedComponent#loadFile:member(1)", "docComment": "/**\n * Load the file into the component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadFile(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadFile" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedContext:interface", "docComment": "/**\n * A context to configure embedding of a file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedContext " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedContext.d.ts", "releaseTag": "Public", "name": "EmbedContext", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedContext#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedContext#containerEl:member", "docComment": "/**\n * Element where the embed should be displayed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedContext#depth:member", "docComment": "/**\n * Depth of the embed within its container (how many levels of embeds are above it).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "depth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "depth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedContext#displayMode:member", "docComment": "/**\n * Whether the embed should be dynamic (CM) or static (postProcessed).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayMode?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "displayMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedContext#linktext:member", "docComment": "/**\n * Text that should be displayed in the embed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linktext?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "linktext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedContext#showInline:member", "docComment": "/**\n * Whether the embed should be an inline embed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showInline?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showInline", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedContext#sourcePath:member", "docComment": "/**\n * Optional path to the current open file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourcePath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sourcePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedContext#state:member", "docComment": "/**\n * Serialized state to restore for the embed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!EmbedCreator:type", "docComment": "/**\n * Creates an embed component for a given file.\n *\n * @param context - Context used to embed the file.\n *\n * @param file - File to embed.\n *\n * @param subpath - Optional subpath within the file.\n *\n * @returns An embed component.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type EmbedCreator = " }, { "kind": "Content", "text": "(context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", subpath?: string) => " }, { "kind": "Reference", "text": "EmbedComponent", "canonicalReference": "obsidian-typings!EmbedComponent:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedCreator.d.ts", "releaseTag": "Public", "name": "EmbedCreator", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbeddedEditorView:interface", "docComment": "/**\n * View for an embedded markdown editor, supporting preview and edit modes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbeddedEditorView extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/EmbeddedEditorView.d.ts", "releaseTag": "Public", "name": "EmbeddedEditorView", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#containerEl:member", "docComment": "/**\n * Container element for the embedded view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#destroyEditor:member(1)", "docComment": "/**\n * Destroy edit component editor and save contents if specified.\n *\n * @param save - Whether to save before destroying.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroyEditor(save?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "save", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "destroyEditor" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#dirty:member", "docComment": "/**\n * Whether the view is currently saving.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dirty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dirty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#editable:member", "docComment": "/**\n * Whether the editor may be edited.\n *\n * @remark\n *\n * Fun fact, setting this to `true` and calling showEditor() for embedded MD views, allows them to be edited. Though the experience is a little buggy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "editable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#editMode:member", "docComment": "/**\n * Editor component of the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editMode?: " }, { "kind": "Reference", "text": "IFramedMarkdownEditor", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "editMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Property", "canonicalReference": "obsidian-typings!EmbeddedEditorView#editor:member", "docComment": "/**\n * Get the preview editor, if exists.\n *\n * @returns The iframed markdown editor, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get editor(): " }, { "kind": "Reference", "text": "IFramedMarkdownEditor", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "editor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#editorEl:member", "docComment": "/**\n * Container in which the editor is embedded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editorEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "editorEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#file:member", "docComment": "/**\n * File to which the view is attached.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#getMode:member(1)", "docComment": "/**\n * Gets currently active mode (editMode returns 'source').\n *\n * @returns The current view mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMode(): " }, { "kind": "Content", "text": "'preview' | 'source'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#hoverPopover:member", "docComment": "/**\n * Hover element container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverPopover: " }, { "kind": "Reference", "text": "HoverPopover", "canonicalReference": "obsidian!HoverPopover:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverPopover", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#onload:member(1)", "docComment": "/**\n * On load of editor, show preview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#onMarkdownScroll:member(1)", "docComment": "/**\n * Trigger markdown scroll on workspace.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMarkdownScroll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onMarkdownScroll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#onunload:member(1)", "docComment": "/**\n * On unload of editor, destroy editor and unset workspace activeEditor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onunload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onunload" }, { "kind": "Property", "canonicalReference": "obsidian-typings!EmbeddedEditorView#path:member", "docComment": "/**\n * Get the path to the file, if any file registered.\n *\n * @returns The file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get path(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#previewEl:member", "docComment": "/**\n * Element containing the preview for the embedded markdown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "previewEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "previewEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#previewMode:member", "docComment": "/**\n * Preview component of the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "previewMode: " }, { "kind": "Reference", "text": "MarkdownPreviewView", "canonicalReference": "obsidian!MarkdownPreviewView:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "previewMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#requestSave:member(1)", "docComment": "/**\n * Debounced save of contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestSave(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "requestSave" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#requestSaveFolds:member(1)", "docComment": "/**\n * Debounced save of editor folds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestSaveFolds(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "requestSaveFolds" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#save:member(1)", "docComment": "/**\n * Set file contents.\n *\n * @param data - Content to save.\n *\n * @param save - Whether to persist to disk.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "save(data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", save?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "save", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "save" }, { "kind": "Property", "canonicalReference": "obsidian-typings!EmbeddedEditorView#scroll:member", "docComment": "/**\n * Get the scroll of the file renderer component.\n *\n * @returns The scroll position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get scroll(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "scroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#set:member(1)", "docComment": "/**\n * Set the state of the editor.\n *\n * @param data - Document content to set.\n *\n * @param clear - Whether to clear existing state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "set(data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", clear: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "clear", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "set" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#showEditor:member(1)", "docComment": "/**\n * Reveal the editor if editable widget and applies saved state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showEditor(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showEditor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#showPreview:member(1)", "docComment": "/**\n * Reveal preview mode and destroy editor, save if specified.\n *\n * @param save - Whether to save before switching to preview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showPreview(save?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "save", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "showPreview" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#showSearch:member(1)", "docComment": "/**\n * Reveal search component in file renderer component.\n *\n * @param replace - Whether to show the replace input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSearch(replace?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replace", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "showSearch" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#state:member", "docComment": "/**\n * Current state of the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#text:member", "docComment": "/**\n * Text contents being embedded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#toggleMode:member(1)", "docComment": "/**\n * Toggle between edit and preview mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleMode(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleMode" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbeddedEditorView#useIframe:member", "docComment": "/**\n * Whether the view renders contents using an iFrame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useIframe: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "useIframe", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface", "docComment": "/**\n * A component that renders an embedded image file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedImageComponent extends " }, { "kind": "Reference", "text": "EmbedComponent", "canonicalReference": "obsidian-typings!EmbedComponent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedImageComponent.d.ts", "releaseTag": "Public", "name": "EmbedImageComponent", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedMarkdownComponent:interface", "docComment": "/**\n * A component that renders an embedded markdown file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedMarkdownComponent extends " }, { "kind": "Reference", "text": "EmbedComponent", "canonicalReference": "obsidian-typings!EmbedComponent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedMarkdownComponent.d.ts", "releaseTag": "Public", "name": "EmbedMarkdownComponent", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedPdfComponent:interface", "docComment": "/**\n * A component that renders an embedded PDF file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedPdfComponent extends " }, { "kind": "Reference", "text": "EmbedComponent", "canonicalReference": "obsidian-typings!EmbedComponent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedPdfComponent.d.ts", "releaseTag": "Public", "name": "EmbedPdfComponent", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedRegistry:interface", "docComment": "/**\n * A registry for embeddable files components.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedRegistry extends " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedRegistry.d.ts", "releaseTag": "Public", "name": "EmbedRegistry", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistry#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getEmbedRegistryConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EmbedRegistry#embedByExtension:member", "docComment": "/**\n * Mapping of file extensions to constructors for embeddable widgets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "embedByExtension: " }, { "kind": "Reference", "text": "EmbedRegistryEmbedByExtensionRecord", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "embedByExtension", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistry#getEmbedCreator:member(1)", "docComment": "/**\n * Get the embed constructor for a specific file type.\n *\n * @param file - File to get the embed creator for.\n *\n * @returns The embed creator, or `null` if none registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEmbedCreator(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedCreator", "canonicalReference": "obsidian-typings!EmbedCreator:type" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getEmbedCreator" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistry#isExtensionRegistered:member(1)", "docComment": "/**\n * Check whether a file extension has a registered embed constructor.\n *\n * @param extension - File extension to check.\n *\n * @returns Whether the extension is registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isExtensionRegistered(extension: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extension", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isExtensionRegistered" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistry#registerExtension:member(1)", "docComment": "/**\n * Register an embed constructor for a specific file extension.\n *\n * @param extension - File extension to register.\n *\n * @param embedCreator - Embed creator function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerExtension(extension: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", embedCreator: " }, { "kind": "Reference", "text": "EmbedCreator", "canonicalReference": "obsidian-typings!EmbedCreator:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extension", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "embedCreator", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "registerExtension" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistry#registerExtensions:member(1)", "docComment": "/**\n * Register an embed constructor for a list of file extensions.\n *\n * @param extensions - File extensions to register.\n *\n * @param embedCreator - Embed creator function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerExtensions(extensions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", embedCreator: " }, { "kind": "Reference", "text": "EmbedCreator", "canonicalReference": "obsidian-typings!EmbedCreator:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extensions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "embedCreator", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "registerExtensions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistry#unregisterExtension:member(1)", "docComment": "/**\n * Unregister an embed constructor for a specific file extension.\n *\n * @param extension - File extension to unregister.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unregisterExtension(extension: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extension", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unregisterExtension" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistry#unregisterExtensions:member(1)", "docComment": "/**\n * Unregister an embed constructor for a list of file extensions.\n *\n * @param extensions - File extensions to unregister.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unregisterExtensions(extensions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extensions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unregisterExtensions" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord:interface", "docComment": "/**\n * A record of embeddable file extensions and their creators.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedRegistryEmbedByExtensionRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "EmbedCreator", "canonicalReference": "obsidian-typings!EmbedCreator:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedRegistryEmbedByExtensionRecord.d.ts", "releaseTag": "Public", "name": "EmbedRegistryEmbedByExtensionRecord", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#\"3gp\":member(1)", "docComment": "/**\n * Creates an embed component for a 3GP file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension._3gp", "canonicalReference": "obsidian-typings!~__type#_3gp" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedAudioComponent", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "\"3gp\"" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#avif:member(1)", "docComment": "/**\n * Creates an embed component for an AVIF file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.avif", "canonicalReference": "obsidian-typings!~__type#avif" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedImageComponent", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "avif" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#bmp:member(1)", "docComment": "/**\n * Creates an embed component for a BMP file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.bmp", "canonicalReference": "obsidian-typings!~__type#bmp" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedImageComponent", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "bmp" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#canvas:member(1)", "docComment": "/**\n * Creates an embed component for a canvas file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.canvas", "canonicalReference": "obsidian-typings!~__type#canvas" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", subpath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedCanvasComponent", "canonicalReference": "obsidian-typings!EmbedCanvasComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "subpath", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "canvas" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#flac:member(1)", "docComment": "/**\n * Creates an embed component for a FLAC file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.flac", "canonicalReference": "obsidian-typings!~__type#flac" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedAudioComponent", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "flac" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#gif:member(1)", "docComment": "/**\n * Creates an embed component for a GIF file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.gif", "canonicalReference": "obsidian-typings!~__type#gif" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedImageComponent", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "gif" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#jpeg:member(1)", "docComment": "/**\n * Creates an embed component for a JPEG file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.jpeg", "canonicalReference": "obsidian-typings!~__type#jpeg" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedImageComponent", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "jpeg" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#jpg:member(1)", "docComment": "/**\n * Creates an embed component for a JPG file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.jpg", "canonicalReference": "obsidian-typings!~__type#jpg" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedImageComponent", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "jpg" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#m4a:member(1)", "docComment": "/**\n * Creates an embed component for an M4A file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.m4a", "canonicalReference": "obsidian-typings!~__type#m4a" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedAudioComponent", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "m4a" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#md:member(1)", "docComment": "/**\n * Creates an embed component for a markdown file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.md", "canonicalReference": "obsidian-typings!~__type#md" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", subpath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedMarkdownComponent", "canonicalReference": "obsidian-typings!EmbedMarkdownComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "subpath", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "md" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#mkv:member(1)", "docComment": "/**\n * Creates an embed component for a MKV file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.mkv", "canonicalReference": "obsidian-typings!~__type#mkv" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedVideoComponent", "canonicalReference": "obsidian-typings!EmbedVideoComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "mkv" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#mov:member(1)", "docComment": "/**\n * Creates an embed component for a MOV file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.mov", "canonicalReference": "obsidian-typings!~__type#mov" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedVideoComponent", "canonicalReference": "obsidian-typings!EmbedVideoComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "mov" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#mp3:member(1)", "docComment": "/**\n * Creates an embed component for an MP3 file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.mp3", "canonicalReference": "obsidian-typings!~__type#mp3" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedAudioComponent", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "mp3" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#mp4:member(1)", "docComment": "/**\n * Creates an embed component for an MP4 file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.mp4", "canonicalReference": "obsidian-typings!~__type#mp4" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedVideoComponent", "canonicalReference": "obsidian-typings!EmbedVideoComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "mp4" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#oga:member(1)", "docComment": "/**\n * Creates an embed component for an OGA file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.oga", "canonicalReference": "obsidian-typings!~__type#oga" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedAudioComponent", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "oga" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#ogg:member(1)", "docComment": "/**\n * Creates an embed component for an OGG file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.ogg", "canonicalReference": "obsidian-typings!~__type#ogg" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedAudioComponent", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "ogg" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#ogv:member(1)", "docComment": "/**\n * Creates an embed component for an OGV file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.ogv", "canonicalReference": "obsidian-typings!~__type#ogv" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedVideoComponent", "canonicalReference": "obsidian-typings!EmbedVideoComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "ogv" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#opus:member(1)", "docComment": "/**\n * Creates an embed component for an OPUS file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.opus", "canonicalReference": "obsidian-typings!~__type#opus" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedAudioComponent", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "opus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#pdf:member(1)", "docComment": "/**\n * Creates an embed component for a PDF file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.pdf", "canonicalReference": "obsidian-typings!~__type#pdf" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", subpath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedPdfComponent", "canonicalReference": "obsidian-typings!EmbedPdfComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "subpath", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "pdf" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#png:member(1)", "docComment": "/**\n * Creates an embed component for a PNG file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.png", "canonicalReference": "obsidian-typings!~__type#png" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedImageComponent", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "png" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#svg:member(1)", "docComment": "/**\n * Creates an embed component for an SVG file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.svg", "canonicalReference": "obsidian-typings!~__type#svg" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedImageComponent", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "svg" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#wav:member(1)", "docComment": "/**\n * Creates an embed component for a WAV file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.wav", "canonicalReference": "obsidian-typings!~__type#wav" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedAudioComponent", "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "wav" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#webm:member(1)", "docComment": "/**\n * Creates an embed component for a WEBM file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.webm", "canonicalReference": "obsidian-typings!~__type#webm" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedVideoComponent", "canonicalReference": "obsidian-typings!EmbedVideoComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "webm" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmbedRegistryEmbedByExtensionRecord#webp:member(1)", "docComment": "/**\n * Creates an embed component for a WEBP file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.webp", "canonicalReference": "obsidian-typings!~__type#webp" }, { "kind": "Content", "text": "](context: " }, { "kind": "Reference", "text": "EmbedContext", "canonicalReference": "obsidian-typings!EmbedContext:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EmbedImageComponent", "canonicalReference": "obsidian-typings!EmbedImageComponent:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "webp" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmbedVideoComponent:interface", "docComment": "/**\n * A component that renders an embedded video file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmbedVideoComponent extends " }, { "kind": "Reference", "text": "EmbedComponent", "canonicalReference": "obsidian-typings!EmbedComponent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/embed-registry/EmbedVideoComponent.d.ts", "releaseTag": "Public", "name": "EmbedVideoComponent", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmptyFunction:interface", "docComment": "/**\n * Function `Empty`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmptyFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/EmptyFunction.d.ts", "releaseTag": "Public", "name": "EmptyFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EmptyView:interface", "docComment": "/**\n * View displayed when a workspace leaf has no content or file open.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EmptyView extends " }, { "kind": "Reference", "text": "ItemView", "canonicalReference": "obsidian!ItemView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/EmptyView.d.ts", "releaseTag": "Public", "name": "EmptyView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EmptyView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The view type identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Empty", "canonicalReference": "obsidian-typings!~__type#Empty:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EnclosingTag:interface", "docComment": "/**\n * Represents an enclosing HTML/XML tag pair with open and close ranges.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EnclosingTag " } ], "fileUrlPath": "src/@codemirror__view/internals/EnclosingTag.d.ts", "releaseTag": "Public", "name": "EnclosingTag", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EnclosingTag#close:member", "docComment": "/**\n * Range of the closing tag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close: " }, { "kind": "Reference", "text": "EditorRangeEx", "canonicalReference": "obsidian-typings!EditorRangeEx:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "close", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EnclosingTag#open:member", "docComment": "/**\n * Range of the opening tag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "open: " }, { "kind": "Reference", "text": "EditorRangeEx", "canonicalReference": "obsidian-typings!EditorRangeEx:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "open", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EnsureSideLeafOptions:interface", "docComment": "/**\n * Options for ensuring a side leaf exists in the workspace.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EnsureSideLeafOptions " } ], "fileUrlPath": "src/obsidian/internals/EnsureSideLeafOptions.d.ts", "releaseTag": "Public", "name": "EnsureSideLeafOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EnsureSideLeafOptions#active:member", "docComment": "/**\n * Whether the leaf should be set as active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "active?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "active", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EnsureSideLeafOptions#reveal:member", "docComment": "/**\n * Whether the leaf should be revealed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reveal?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "reveal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EnsureSideLeafOptions#split:member", "docComment": "/**\n * Whether to create a new split for the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "split?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "split", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EnsureSideLeafOptions#state:member", "docComment": "/**\n * The state to set on the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Environment:interface", "docComment": "/**\n * Environment object passed to Prism hooks and used during highlighting.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Environment " } ], "fileUrlPath": "src/prismjs/internals/Environment.d.ts", "releaseTag": "Public", "name": "Environment", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#attributes:member", "docComment": "/**\n * Additional attributes for the wrapping element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attributes?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "attributes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#classes:member", "docComment": "/**\n * CSS classes applied to the token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "classes?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "classes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#code:member", "docComment": "/**\n * The source code to highlight.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "code?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "code", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#content:member", "docComment": "/**\n * The content of a token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "content?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#element:member", "docComment": "/**\n * The target element being highlighted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "element?: " }, { "kind": "Reference", "text": "Element", "canonicalReference": "!Element:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "element", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#grammar:member", "docComment": "/**\n * The grammar used for tokenization.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "grammar?: " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "grammar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#highlightedCode:member", "docComment": "/**\n * The highlighted HTML code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlightedCode?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "highlightedCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#language:member", "docComment": "/**\n * The language identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "language?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "language", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#parent:member", "docComment": "/**\n * The parent token array.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#selector:member", "docComment": "/**\n * CSS selector used to find code elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selector?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selector", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#tag:member", "docComment": "/**\n * The HTML tag name for the token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tag?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tag", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#tokenSequence:member", "docComment": "/**\n * The token sequence.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tokenSequence?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tokenSequence", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Environment#type:member", "docComment": "/**\n * The type of the token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EqualFunction:interface", "docComment": "/**\n * Function `Equal`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EqualFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/EqualFunction.d.ts", "releaseTag": "Public", "name": "EqualFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Function", "canonicalReference": "obsidian-typings!evaluateBaseHeadless:function(1)", "docComment": "/**\n * Evaluate a `.base` file in headless mode — with no leaf or open view — and return its entries.\n *\n * It renders the base off-screen via {@link getBasesControllerFromRender}, waits for the initial vault scan to settle, then reads the controller's results. Everything is torn down before returning.\n *\n * @param app - The app instance.\n *\n * @param content - The `.base` file content (the body of a `base` code block).\n *\n * @param sourcePath - The path supplying the query's file context.\n *\n * @returns The evaluated base entries.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function evaluateBaseHeadless(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", sourcePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesEntry", "canonicalReference": "obsidian!BasesEntry:class" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/functions/evaluateBaseHeadless.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "sourcePath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "evaluateBaseHeadless" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!EventsEntry:interface", "docComment": "/**\n * An entry representing a registered event handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EventsEntry " } ], "fileUrlPath": "src/obsidian/internals/EventsEntry.d.ts", "releaseTag": "Public", "name": "EventsEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EventsEntry#ctx:member", "docComment": "/**\n * Context (`this` value) for the event handler callback.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ctx: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ctx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EventsEntry#e:member", "docComment": "/**\n * Events object this handler is registered on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "e: " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "e", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!EventsEntry#fn:member(1)", "docComment": "/**\n * Event handler callback function.\n *\n * @param data - The event data arguments.\n *\n * @returns The result of the event handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fn(...data: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "fn" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!EventsEntry#name:member", "docComment": "/**\n * Event name this handler listens for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!exists:var", "docComment": "/**\n * Checks whether a translation key exists.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exists: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['exists']" } ], "fileUrlPath": "src/i18next/internals/functions/exists.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "exists", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ExtendedMetrics:interface", "docComment": "/**\n * Font metrics used by MathJax for scaling and positioning math output.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ExtendedMetrics " } ], "fileUrlPath": "src/mathjax/internals/ExtendedMetrics.d.ts", "releaseTag": "Public", "name": "ExtendedMetrics", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ExtendedMetrics#containerWidth:member", "docComment": "/**\n * Width of the container element in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerWidth: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ExtendedMetrics#em:member", "docComment": "/**\n * Size of 1em in pixels for the current font.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "em: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "em", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ExtendedMetrics#ex:member", "docComment": "/**\n * Size of 1ex in pixels for the current font.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ExtendedMetrics#family:member", "docComment": "/**\n * CSS font family string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "family: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "family", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ExtendedMetrics#lineWidth:member", "docComment": "/**\n * Available line width for the math output in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineWidth: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ExtendedMetrics#scale:member", "docComment": "/**\n * Scale factor for the math output relative to the surrounding text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ExternalDiagramDefinition:interface", "docComment": "/**\n * Definition for registering an external Mermaid diagram type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ExternalDiagramDefinition " } ], "fileUrlPath": "src/mermaid/internals/ExternalDiagramDefinition.d.ts", "releaseTag": "Public", "name": "ExternalDiagramDefinition", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ExternalDiagramDefinition#detector:member(1)", "docComment": "/**\n * Detect whether the given text matches this diagram type.\n *\n * @param text - The diagram text to check.\n *\n * @returns Whether the text matches this diagram type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detector(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "detector" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ExternalDiagramDefinition#id:member", "docComment": "/**\n * Unique identifier for the diagram type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ExternalDiagramDefinition#loader:member(1)", "docComment": "/**\n * Lazily load the diagram definition.\n *\n * @returns A promise resolving to the diagram definition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loader(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DiagramDefinitionModule", "canonicalReference": "obsidian-typings!DiagramDefinitionModule:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loader" } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ExtractConstructor:type", "docComment": "/**\n * Extracts a constructor type from an interface that defines a `constructor__`, `constructor2__`, `constructor3__`, `constructor4__`, or `constructor5__` method.\n *\n * Prefers higher-numbered variants over lower-numbered ones when multiple are present, since higher-numbered variants represent deeper subclass constructors when ancestor classes already define lower-numbered ones.\n *\n * The `constructor[N]__` helpers are declared optional (`constructor[N]__?`), so matching is done via `'constructor[N]__' extends keyof T` (which sees optional keys) combined with `NonNullable` (which strips the `| undefined` an optional member carries), rather than `T extends { constructor[N]__(): … }` (which no longer matches an optional method). The final branch still accepts a function type passed directly (e.g. `ExtractConstructor<App['constructor__']>`), `NonNullable` likewise tolerating its optional `| undefined`.\n *\n * @typeParam T - An interface with a `constructor[N]__` method, or a function type directly.\n *\n * @example\n * ```ts\n * // From an interface:\n * type AppCtor = ExtractConstructor<App>;\n *\n * // From a constructor__ method type directly:\n * type AppCtor = ExtractConstructor<App['constructor__']>;\n * ```\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ExtractConstructor<T> = " }, { "kind": "Content", "text": "'constructor5__' extends keyof T ? " }, { "kind": "Reference", "text": "NonNullable", "canonicalReference": "!NonNullable:type" }, { "kind": "Content", "text": "<T['constructor5__']> extends (...args: infer Args) => infer Instance ? " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<Args, Instance> : never\n : 'constructor4__' extends keyof T ? " }, { "kind": "Reference", "text": "NonNullable", "canonicalReference": "!NonNullable:type" }, { "kind": "Content", "text": "<T['constructor4__']> extends (...args: infer Args) => infer Instance ? " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<Args, Instance> : never\n : 'constructor3__' extends keyof T ? " }, { "kind": "Reference", "text": "NonNullable", "canonicalReference": "!NonNullable:type" }, { "kind": "Content", "text": "<T['constructor3__']> extends (...args: infer Args) => infer Instance ? " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<Args, Instance> : never\n : 'constructor2__' extends keyof T ? " }, { "kind": "Reference", "text": "NonNullable", "canonicalReference": "!NonNullable:type" }, { "kind": "Content", "text": "<T['constructor2__']> extends (...args: infer Args) => infer Instance ? " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<Args, Instance> : never\n : 'constructor__' extends keyof T ? " }, { "kind": "Reference", "text": "NonNullable", "canonicalReference": "!NonNullable:type" }, { "kind": "Content", "text": "<T['constructor__']> extends (...args: infer Args) => infer Instance ? " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<Args, Instance> : never\n : " }, { "kind": "Reference", "text": "NonNullable", "canonicalReference": "!NonNullable:type" }, { "kind": "Content", "text": "<T> extends (...args: infer Args) => infer Instance ? " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<Args, Instance>\n : never" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/constructors/ExtractConstructor.d.ts", "releaseTag": "Public", "name": "ExtractConstructor", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 26 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FacetConfig:interface", "docComment": "/**\n * Configuration for defining a facet.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FacetConfig<Input, Output> " } ], "fileUrlPath": "src/@codemirror__state/internals/FacetConfig.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Input", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Output", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "FacetConfig", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FacetConfig#combine:member(1)", "docComment": "/**\n * Combine the input values into a single output value.\n *\n * @param values - The input values.\n *\n * @returns The combined output.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "combine?(values: " }, { "kind": "Content", "text": "readonly Input[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "Output" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "combine" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FacetConfig#compare:member(1)", "docComment": "/**\n * Compare two output values.\n *\n * @param a - The first value.\n *\n * @param b - The second value.\n *\n * @returns Whether the values are equal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compare?(a: " }, { "kind": "Content", "text": "Output" }, { "kind": "Content", "text": ", b: " }, { "kind": "Content", "text": "Output" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "a", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "compare" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FacetConfig#compareInput:member(1)", "docComment": "/**\n * Compare two input values.\n *\n * @param a - The first value.\n *\n * @param b - The second value.\n *\n * @returns Whether the values are equal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compareInput?(a: " }, { "kind": "Content", "text": "Input" }, { "kind": "Content", "text": ", b: " }, { "kind": "Content", "text": "Input" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "a", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "compareInput" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FacetConfig#enables:member", "docComment": "/**\n * Extensions or a function producing extensions to enable when this facet is provided.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enables?: " }, { "kind": "Content", "text": "((self: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "obsidian-typings!~Facet" }, { "kind": "Content", "text": "<Input, Output>) => " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": ") | " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enables", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FacetConfig#static:member", "docComment": "/**\n * Whether this facet's value is static (cannot be changed by transactions).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "static", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileBookmarkItem:interface", "docComment": "/**\n * {@link Bookmark} item representing a bookmarked file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileBookmarkItem extends " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/bookmark-items/FileBookmarkItem.d.ts", "releaseTag": "Public", "name": "FileBookmarkItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileBookmarkItem#path:member", "docComment": "/**\n * Vault-relative path to the bookmarked file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileBookmarkItem#subpath:member", "docComment": "/**\n * Subpath within the file (e.g. heading or block reference).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subpath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileBookmarkItem#type:member", "docComment": "/**\n * Discriminator indicating this is a file bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'file'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileCacheEntry:interface", "docComment": "/**\n * Cache entry storing file hash, modification time, and size.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileCacheEntry " } ], "fileUrlPath": "src/obsidian/internals/FileCacheEntry.d.ts", "releaseTag": "Public", "name": "FileCacheEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileCacheEntry#hash:member", "docComment": "/**\n * Hash of file contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hash: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hash", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileCacheEntry#mtime:member", "docComment": "/**\n * Last modified time of file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mtime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mtime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileCacheEntry#size:member", "docComment": "/**\n * Size of file in bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "size", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileEntry:interface", "docComment": "/**\n * Represents a file or folder entry in the data adapter's file listing.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileEntry extends " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileStats", "canonicalReference": "obsidian!FileStats:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/FileEntry.d.ts", "releaseTag": "Public", "name": "FileEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileEntry#name:member", "docComment": "/**\n * Name of file or folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileEntry#realpath:member", "docComment": "/**\n * Full path to file or folder.\n *\n * @remark\n *\n * Might be used for resolving symlinks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "realpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "realpath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileEntry#type:member", "docComment": "/**\n * Type of entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'file' | 'folder'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileEntry#uri:member", "docComment": "/**\n * URI of file or folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uri?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "uri", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileExplorerPlugin:interface", "docComment": "/**\n * Internal plugin registration for the file explorer sidebar.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileExplorerPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileExplorerPluginInstance", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/FileExplorerPlugin.d.ts", "releaseTag": "Public", "name": "FileExplorerPlugin", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerPlugin#registerCliHandler:member(1)", "docComment": "/**\n * Registers a CLI handler for the file explorer.\n *\n * @param command - The command ID.\n *\n * @param description - The help/autocomplete description.\n *\n * @param flags - The CLI flags, or `null`.\n *\n * @param handler - The handler callback.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerCliHandler(command: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", description: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", flags: " }, { "kind": "Reference", "text": "CliFlags", "canonicalReference": "obsidian!CliFlags:type" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Reference", "text": "CliHandler", "canonicalReference": "obsidian!CliHandler:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "description", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "flags", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "isOptional": false } ], "name": "registerCliHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerPlugin#revealInFolder:member(1)", "docComment": "/**\n * Reveals a file or folder in the file explorer view, opens the view if it is not already. open/visible.\n *\n * @param item - The file or folder to reveal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "revealInFolder(item: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "revealInFolder" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance:interface", "docComment": "/**\n * Plugin instance for the file explorer, managing the file tree sidebar view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileExplorerPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileExplorerPlugin", "canonicalReference": "obsidian-typings!FileExplorerPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/FileExplorerPluginInstance.d.ts", "releaseTag": "Public", "name": "FileExplorerPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance#initLeaf:member(1)", "docComment": "/**\n * Ensures the file explorer leaf exists in the left sidebar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initLeaf(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initLeaf" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance#onFileMenu:member(1)", "docComment": "/**\n * Adds file-explorer items to the file context menu.\n *\n * @param menu - The menu to add to.\n *\n * @param file - The file or folder the menu was opened on.\n *\n * @param source - The source of the menu (e.g. `'file-explorer-context-menu'`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onFileMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance#plugin:member", "docComment": "/**\n * Reference to the file explorer plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "FileExplorerPlugin", "canonicalReference": "obsidian-typings!FileExplorerPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance#revealInFolder:member(1)", "docComment": "/**\n * Reveals a file or folder in the file explorer view, opens the view if it is not already. open/visible.\n *\n * @param item - The file or folder to reveal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "revealInFolder(item: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "revealInFolder" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileExplorerView:interface", "docComment": "/**\n * {@link obsidian#View} that renders the file explorer tree sidebar for navigating vault files and folders.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileExplorerView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/FileExplorerView.d.ts", "releaseTag": "Public", "name": "FileExplorerView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#acceptRename:member(1)", "docComment": "/**\n * Try to rename the file.\n *\n * @returns A promise that resolves when the rename is accepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "acceptRename(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "acceptRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#afterCreate:member(1)", "docComment": "/**\n * Is Executed after creating the file or folder and opens the view and/or starts the rename.\n *\n * @param file - The created file.\n *\n * @param newLeaf - Where to open the view for this file.\n *\n * @returns A promise that resolves when the file is opened and/or rename is started.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "afterCreate(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", newLeaf: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "PaneType", "canonicalReference": "obsidian!PaneType:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newLeaf", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "afterCreate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#attachDropHandler:member(1)", "docComment": "/**\n * Used internally to attach drop handler to the tree root and folder items.\n *\n * @param folder - Folder that's associated with the item.\n *\n * @param el - Element of the tree root or folder item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attachDropHandler(folder: " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": ", el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "folder", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "el", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "attachDropHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#attachFileEvents:member(1)", "docComment": "/**\n * Attach file-related event listeners to an element.\n *\n * @param e - The element to attach events to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attachFileEvents(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "attachFileEvents" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#createAbstractFile:member(1)", "docComment": "/**\n * Creates an file or folder.\n *\n * @param type - The type of file to create.\n *\n * @param location - The location where to create the file.\n *\n * @param newLeaf - Where to open the view for this file.\n *\n * @returns A promise that resolves when the file or folder is created.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createAbstractFile(type: " }, { "kind": "Content", "text": "'file' | 'folder'" }, { "kind": "Content", "text": ", location: " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": ", newLeaf: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "PaneType", "canonicalReference": "obsidian!PaneType:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "location", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "newLeaf", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": false } ], "name": "createAbstractFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#createFolderDom:member(1)", "docComment": "/**\n * Create a tree item DOM element for the given folder.\n *\n * @param folder - The folder to create a tree item for.\n *\n * @returns The created folder tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFolderDom(folder: " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "folder", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createFolderDom" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#createItemDom:member(1)", "docComment": "/**\n * Create a tree item DOM element for the given file.\n *\n * @param file - The file to create a tree item for.\n *\n * @returns The created file tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createItemDom(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createItemDom" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#displayError:member(1)", "docComment": "/**\n * Display an error message on a file tree item.\n *\n * @param message - The error message to display.\n *\n * @param fileItem - The file tree item to display the error on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayError(message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", fileItem: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fileItem", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "displayError" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#dragFiles:member(1)", "docComment": "/**\n * Handle dragging files from the file explorer.\n *\n * @param event - The drag event.\n *\n * @param t - The drag target information.\n *\n * @returns The drag result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragFiles(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "dragFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#exitRename:member(1)", "docComment": "/**\n * Quits the rename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exitRename(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "exitRename" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerView#fileItems:member", "docComment": "/**\n * Mapping of file path to tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fileItems: " }, { "kind": "Reference", "text": "FileExplorerViewFileItemsRecord", "canonicalReference": "obsidian-typings!FileExplorerViewFileItemsRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fileItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerView#files:member", "docComment": "/**\n * Mapping of tree self element to abstract file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "files: " }, { "kind": "Reference", "text": "WeakMapWrapper", "canonicalReference": "obsidian-typings!WeakMapWrapper:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "files", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#getNodeId:member(1)", "docComment": "/**\n * Get the unique node identifier for a tree item.\n *\n * @param e - The tree item.\n *\n * @returns The node identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNodeId(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getNodeId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#getSortedFolderItems:member(1)", "docComment": "/**\n * Get a sorted list of the tree items for a specific folder).\n *\n * @param folder - The folder to get sorted items for.\n *\n * @returns The sorted file tree items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSortedFolderItems(folder: " }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FileTreeItem", "canonicalReference": "obsidian-typings!FileTreeItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "folder", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSortedFolderItems" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The file explorer view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.FileExplorer", "canonicalReference": "obsidian-typings!~__type#FileExplorer:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#isItem:member(1)", "docComment": "/**\n * Check whether the given object is a file tree item.\n *\n * @param item - The object to check.\n *\n * @returns Whether the object is a file tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isItem(item: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerView#lastDropTargetEl:member", "docComment": "/**\n * Last dragged over folder item element. `null` when there is no folder item being dragged over.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastDropTargetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastDropTargetEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerView#mouseoverExpandTimeout:member", "docComment": "/**\n * Timeout ID for expanding a folder on mouseover during drag, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mouseoverExpandTimeout: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mouseoverExpandTimeout", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onCreate:member(1)", "docComment": "/**\n * Is called when a new file is created in vault. Updates the file tree.\n *\n * @param file - The new file or folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCreate(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onCreate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onCreateNewFolderClick:member(1)", "docComment": "/**\n * Is called when on the new folder icon is clicked. Call createAbstractFile().\n *\n * @param event - The MouseEvent which triggered this function.\n *\n * @returns A promise that resolves when the folder is created.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCreateNewFolderClick(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onCreateNewFolderClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onCreateNewNoteClick:member(1)", "docComment": "/**\n * Is called when on the new note icon is clicked. Call createAbstractFile().\n *\n * @param event - The MouseEvent which triggered this function.\n *\n * @returns A promise that resolves when the note is created.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCreateNewNoteClick(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onCreateNewNoteClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onDelete:member(1)", "docComment": "/**\n * Is called when a file in vault is deleted. Updates the file tree.\n *\n * @param file - The deleted file or folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDelete(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDelete" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onDeleteSelectedFiles:member(1)", "docComment": "/**\n * Called when delete is requested.\n *\n * @param event - The event triggered this function.\n *\n * @returns The result of the delete operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDeleteSelectedFiles(event: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onDeleteSelectedFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onExtensionsUpdated:member(1)", "docComment": "/**\n * Called when a extensions update is triggered. Event: 'extensions-updated'.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExtensionsUpdated(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExtensionsUpdated" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onFileMouseout:member(1)", "docComment": "/**\n * Called when the mouse pointer moves away from an element. Event: 'mouseout'.\n *\n * @param event - The event triggered this function.\n *\n * @param targetEl - The target Element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMouseout(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onFileMouseout" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onFileMouseover:member(1)", "docComment": "/**\n * Called when the mouse pointer is moved over an element. Updates the tooltip information. Event: 'mouseover'.\n *\n * @param event - The event triggered this function.\n *\n * @param targetEl - The target Element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMouseover(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "targetEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onFileMouseover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onFileOpen:member(1)", "docComment": "/**\n * Called when a file is opened. Brings the file to the front.\n *\n * @param file - The opened file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileOpen(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onFileRenameInput:member(1)", "docComment": "/**\n * Handle input events in the file rename text field.\n *\n * @param e - The input event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileRenameInput(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileRenameInput" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onKeyEnterInRename:member(1)", "docComment": "/**\n * Called when 'Enter' is pressed while rename. Accepts the rename.\n *\n * @param event - The event triggered this function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyEnterInRename(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyEnterInRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onKeyEscInRename:member(1)", "docComment": "/**\n * Called when 'ESC' is pressed while rename. Denies the rename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyEscInRename(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onKeyEscInRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onKeyRename:member(1)", "docComment": "/**\n * Called when the rename shortcut is pressed.\n *\n * @param event - The event triggered this function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyRename(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onModify:member(1)", "docComment": "/**\n * Request a sort if not sorted properly.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onModify(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onModify" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onRename:member(1)", "docComment": "/**\n * Is called when a file in vault is renamed. Updates the file tree.\n *\n * @param file - The renamed file or folder.\n *\n * @param oldPath - The old file or folder path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRename(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", oldPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "oldPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#onTitleBlur:member(1)", "docComment": "/**\n * Called when the title is deselected. Calls acceptRename().\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTitleBlur(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onTitleBlur" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#openFileContextMenu:member(1)", "docComment": "/**\n * Opens the context menu for the file item.\n *\n * @param event - The event.\n *\n * @param fileItemEl - The file item clicked on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openFileContextMenu(event: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": ", fileItemEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fileItemEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "openFileContextMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerView#ready:member", "docComment": "/**\n * Indicate ready state of the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ready: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ready", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerView#requestSort:member", "docComment": "/**\n * Try to sort tree items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestSort: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestSort", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#revealInFolder:member(1)", "docComment": "/**\n * Reveal a file or folder in the file tree.\n *\n * @param file - The file or folder to reveal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "revealInFolder(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "revealInFolder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#setIsAllCollapsed:member(1)", "docComment": "/**\n * Set whether all folders are collapsed.\n *\n * @param e - Whether to collapse all folders.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIsAllCollapsed(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setIsAllCollapsed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#setSortOrder:member(1)", "docComment": "/**\n * Updates the sort order and sort by it.\n *\n * @param order - The sort order.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSortOrder(order: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "order", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSortOrder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#sort:member(1)", "docComment": "/**\n * Sorts the file items in this view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sort(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "sort" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerView#sortOrder:member", "docComment": "/**\n * Current sort order of file tree items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sortOrder: " }, { "kind": "Reference", "text": "FileExplorerViewSortOrder", "canonicalReference": "obsidian-typings!FileExplorerViewSortOrder:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sortOrder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#startRenameFile:member(1)", "docComment": "/**\n * Begin inline renaming of a file tree item.\n *\n * @param e - The file tree item to rename.\n *\n * @returns The rename result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startRenameFile(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "startRenameFile" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileExplorerView#tree:member", "docComment": "/**\n * {@link Tree} view of files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tree: " }, { "kind": "Reference", "text": "Tree", "canonicalReference": "obsidian-typings!Tree:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileTreeItem", "canonicalReference": "obsidian-typings!FileTreeItem:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FolderTreeItem", "canonicalReference": "obsidian-typings!FolderTreeItem:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tree", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileExplorerView#updateConfig:member(1)", "docComment": "/**\n * Reloads the config from vault and update all items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateConfig(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateConfig" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileExplorerViewFileItemsRecord:interface", "docComment": "/**\n * Record mapping file paths to their corresponding file or folder tree items.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileExplorerViewFileItemsRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "FileTreeItem", "canonicalReference": "obsidian-typings!FileTreeItem:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FolderTreeItem", "canonicalReference": "obsidian-typings!FolderTreeItem:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/FileExplorerViewFileItemsRecord.d.ts", "releaseTag": "Public", "name": "FileExplorerViewFileItemsRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 7 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!FileExplorerViewSortOrder:type", "docComment": "/**\n * Available sort orders for the file explorer view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type FileExplorerViewSortOrder =\n " }, { "kind": "Content", "text": "| 'alphabetical'\n | 'alphabeticalReverse'\n | 'byCreatedTime'\n | 'byCreatedTimeReverse'\n | 'byModifiedTime'\n | 'byModifiedTimeReverse'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/FileExplorerViewSortOrder.d.ts", "releaseTag": "Public", "name": "FileExplorerViewSortOrder", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "obsidian-typings!FileExtension:var", "docComment": "/**\n * Constant mapping of file extension identifiers recognized and supported by Obsidian.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FileExtension: " }, { "kind": "Content", "text": "{\n readonly _3gp: \"3gp\";\n readonly avif: \"avif\";\n readonly bmp: \"bmp\";\n readonly canvas: \"canvas\";\n readonly flac: \"flac\";\n readonly gif: \"gif\";\n readonly jpeg: \"jpeg\";\n readonly jpg: \"jpg\";\n readonly m4a: \"m4a\";\n readonly md: \"md\";\n readonly mkv: \"mkv\";\n readonly mov: \"mov\";\n readonly mp3: \"mp3\";\n readonly mp4: \"mp4\";\n readonly oga: \"oga\";\n readonly ogg: \"ogg\";\n readonly ogv: \"ogv\";\n readonly opus: \"opus\";\n readonly pdf: \"pdf\";\n readonly png: \"png\";\n readonly svg: \"svg\";\n readonly wav: \"wav\";\n readonly webm: \"webm\";\n readonly webp: \"webp\";\n}" } ], "fileUrlPath": "src/obsidian/implementations/constants/FileExtension.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "FileExtension", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FilePropertiesView:interface", "docComment": "/**\n * {@link obsidian#View} that displays frontmatter properties for the current file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FilePropertiesView extends " }, { "kind": "Reference", "text": "InfoFileView", "canonicalReference": "obsidian-typings!InfoFileView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/properties/FilePropertiesView.d.ts", "releaseTag": "Public", "name": "FilePropertiesView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#constructor3__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param leaf - The workspace leaf.\n *\n * @param propertiesPluginInstance - The properties plugin instance.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor3__?(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", propertiesPluginInstance: " }, { "kind": "Reference", "text": "PropertiesPluginInstance", "canonicalReference": "obsidian-typings!PropertiesPluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "propertiesPluginInstance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor3__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#getFile:member(1)", "docComment": "/**\n * Returns the file.\n *\n * @returns The current file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFile(): " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The file properties view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.FileProperties", "canonicalReference": "obsidian-typings!~__type#FileProperties:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#isSupportedFile:member(1)", "docComment": "/**\n * Checks the file is an markdown file.\n *\n * @param file - The file to check.\n *\n * @returns Whether the file is a supported markdown file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isSupportedFile(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isSupportedFile" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FilePropertiesView#modifyingFile:member", "docComment": "/**\n * The file whose frontmatter the view is currently editing, or `null` when no supported file is loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modifyingFile: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modifyingFile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#onFileChange:member(1)", "docComment": "/**\n * Handle a file content change and refresh properties.\n *\n * @param file - The changed file.\n *\n * @returns Resolves when the properties are refreshed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileChange(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#onQuickPreview:member(1)", "docComment": "/**\n * Handle a quick preview update for the file.\n *\n * @param file - The file being previewed.\n *\n * @param t - The preview data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onQuickPreview(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onQuickPreview" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#readSupportedFile:member(1)", "docComment": "/**\n * Reads the file if it is supported.\n *\n * @param file - The file to read.\n *\n * @returns A promise that resolves with the file contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readSupportedFile(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "readSupportedFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#saveFrontmatter:member(1)", "docComment": "/**\n * Save the modified frontmatter data to the file.\n *\n * @param e - The frontmatter data to save.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveFrontmatter(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "saveFrontmatter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#shiftFocusAfter:member(1)", "docComment": "/**\n * Move focus to the next property field.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shiftFocusAfter(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "shiftFocusAfter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#shiftFocusBefore:member(1)", "docComment": "/**\n * Move focus to the previous property field.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shiftFocusBefore(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "shiftFocusBefore" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#update:member(1)", "docComment": "/**\n * Refresh the file properties view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#updateEmptyState:member(1)", "docComment": "/**\n * Update the empty state display when no properties exist.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateEmptyState(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateEmptyState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertiesView#updateFrontmatter:member(1)", "docComment": "/**\n * Update the frontmatter of a file with new property data.\n *\n * @param file - The file to update.\n *\n * @param t - The new property data.\n *\n * @returns The update result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateFrontmatter(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "updateFrontmatter" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FilePropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for files.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FilePropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/FilePropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "FilePropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FilePropertyWidgetComponent#inputEl:member", "docComment": "/**\n * The input element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FilePropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FilePropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'file'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileRecoveryPlugin:interface", "docComment": "/**\n * Internal plugin registration for the file recovery/snapshots feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileRecoveryPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileRecoveryPluginInstance", "canonicalReference": "obsidian-typings!FileRecoveryPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-recovery/FileRecoveryPlugin.d.ts", "releaseTag": "Public", "name": "FileRecoveryPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileRecoveryPluginInstance:interface", "docComment": "/**\n * Plugin instance for file recovery, managing file snapshots for restoration.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileRecoveryPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileRecoveryPlugin", "canonicalReference": "obsidian-typings!FileRecoveryPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-recovery/FileRecoveryPluginInstance.d.ts", "releaseTag": "Public", "name": "FileRecoveryPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileRecoveryPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileRecoveryPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileSuggest:interface", "docComment": "/**\n * Editor suggestion provider for file and link autocompletion.\n *\n * @typeParam T - The type of the suggestion items.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileSuggest<T> extends " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/FileSuggest.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "FileSuggest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileSuggest#suggestManager:member", "docComment": "/**\n * Manages fetching of suggestions from metadatacache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suggestManager: " }, { "kind": "Reference", "text": "FileSuggestManager", "canonicalReference": "obsidian-typings!FileSuggestManager:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileSuggestion:interface", "docComment": "/**\n * File suggestion.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileSuggestion " } ], "fileUrlPath": "src/obsidian/internals/FileSuggestion.d.ts", "releaseTag": "Public", "name": "FileSuggestion", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileSuggestion#file:member", "docComment": "/**\n * The file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileSuggestion#path:member", "docComment": "/**\n * The path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileSuggestManager:interface", "docComment": "/**\n * File suggest manager.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileSuggestManager " } ], "fileUrlPath": "src/obsidian/internals/FileSuggestManager.d.ts", "releaseTag": "Public", "name": "FileSuggestManager", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileSuggestManager#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileSuggestManager#fileSuggestions:member", "docComment": "/**\n * Selection of files and their paths that can be matched to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fileSuggestions: " }, { "kind": "Reference", "text": "FileSuggestion", "canonicalReference": "obsidian-typings!FileSuggestion:interface" }, { "kind": "Content", "text": "[] | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fileSuggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getBlockSuggestions:member(1)", "docComment": "/**\n * Get suggestions for block query.\n *\n * @param runner - {@link Runnable} controlling the search lifecycle.\n *\n * @param file - File to search within.\n *\n * @param text - Search query text.\n *\n * @returns Matching block suggestions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBlockSuggestions(runner: " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "runner", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "getBlockSuggestions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getDisplaySuggestions:member(1)", "docComment": "/**\n * Get suggestions for display alias query.\n *\n * @param runner - {@link Runnable} controlling the search lifecycle.\n *\n * @param linkpath - Link path to resolve.\n *\n * @param subpath - Subpath within the file.\n *\n * @param alias - Alias text to search.\n *\n * @returns Matching display suggestions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDisplaySuggestions(runner: " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ", linkpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", subpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", alias: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "runner", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "linkpath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "subpath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "alias", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "getDisplaySuggestions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getFileSuggestions:member(1)", "docComment": "/**\n * Get suggestions for file query.\n *\n * @param runner - {@link Runnable} controlling the search lifecycle.\n *\n * @param text - Search query text.\n *\n * @returns Matching file suggestions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFileSuggestions(runner: " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "runner", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getFileSuggestions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getGlobalBlockSuggestions:member(1)", "docComment": "/**\n * Get suggestions for global block query.\n *\n * @param runner - {@link Runnable} controlling the search lifecycle.\n *\n * @param text - Search query text.\n *\n * @returns Matching global block suggestions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGlobalBlockSuggestions(runner: " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "runner", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getGlobalBlockSuggestions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getGlobalHeadingSuggestions:member(1)", "docComment": "/**\n * Get suggestions for global heading query.\n *\n * @param runner - {@link Runnable} controlling the search lifecycle.\n *\n * @param text - Search query text.\n *\n * @returns Matching global heading suggestions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGlobalHeadingSuggestions(runner: " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "runner", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getGlobalHeadingSuggestions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getHeadingSuggestions:member(1)", "docComment": "/**\n * Get suggestions for file heading query.\n *\n * @param runner - {@link Runnable} controlling the search lifecycle.\n *\n * @param file - File to search within.\n *\n * @param text - Search query text.\n *\n * @returns Matching heading suggestions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHeadingSuggestions(runner: " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "runner", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "getHeadingSuggestions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getInstructions:member(1)", "docComment": "/**\n * Generate instructions for specific actions in suggestion manager (e.g. accept, select, ...).\n *\n * @returns Array of instructions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getInstructions(): " }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "Instruction", "canonicalReference": "obsidian!Instruction:interface" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getInstructions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getSourcePath:member(1)", "docComment": "/**\n * Determine the source path of current context.\n *\n * @returns Source path string, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSourcePath(): " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSourcePath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#getSuggestionsAsync:member(1)", "docComment": "/**\n * Get suggestions for current input text.\n *\n * @param runner - {@link Runnable} controlling the search lifecycle.\n *\n * @param text - Search query text.\n *\n * @returns Matching suggestions.\n *\n * @remark\n *\n * Type is determined from text: e.g. [[Thi]] will give completions for files, [[Thi^]] for blocks, etc.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSuggestionsAsync(runner: " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "runner", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getSuggestionsAsync" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileSuggestManager#global:member", "docComment": "/**\n * Whether search should be vault-wide rather than scoped to current file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "global: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "global", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileSuggestManager#matchBlock:member(1)", "docComment": "/**\n * Match search fragments to a block.\n *\n * @param path - Path of the file.\n *\n * @param file - File containing the block.\n *\n * @param block - Block cache entry to match against.\n *\n * @param sourcePath - Source path for link resolution.\n *\n * @param content - Content of the block.\n *\n * @param textParts - Search fragments to match.\n *\n * @returns Search result if matched, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "matchBlock(\n path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ",\n block: " }, { "kind": "Reference", "text": "BlockCache", "canonicalReference": "obsidian!BlockCache:interface" }, { "kind": "Content", "text": ",\n sourcePath: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ",\n content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n textParts: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "block", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "sourcePath", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "textParts", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "name": "matchBlock" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileSuggestManager#mode:member", "docComment": "/**\n * Type of suggestions that should be provided.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mode: " }, { "kind": "Content", "text": "'block' | 'display' | 'file' | 'heading' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileSuggestManager#runnable:member", "docComment": "/**\n * Executor of the search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "runnable: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "runnable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileSystemWatchHandler:interface", "docComment": "/**\n * Callback interface for handling file system watch events.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileSystemWatchHandler " } ], "fileUrlPath": "src/obsidian/internals/FileSystemWatchHandler.d.ts", "releaseTag": "Public", "name": "FileSystemWatchHandler", "preserveMemberOrder": false, "members": [ { "kind": "CallSignature", "canonicalReference": "obsidian-typings!FileSystemWatchHandler:call(1)", "docComment": "/**\n * Handle raw, folder-created, folder-removed, or file-removed events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "(eventType: " }, { "kind": "Content", "text": "'file-removed' | 'folder-created' | 'folder-removed' | 'raw'" }, { "kind": "Content", "text": ", path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ] }, { "kind": "CallSignature", "canonicalReference": "obsidian-typings!FileSystemWatchHandler:call(2)", "docComment": "/**\n * Handle modified or file-created events with file stats.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "(eventType: " }, { "kind": "Content", "text": "'file-created' | 'modified'" }, { "kind": "Content", "text": ", path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", oldPath: " }, { "kind": "Content", "text": "undefined" }, { "kind": "Content", "text": ", stats: " }, { "kind": "Reference", "text": "FileStats", "canonicalReference": "obsidian!FileStats:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "eventType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "oldPath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "stats", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ] }, { "kind": "CallSignature", "canonicalReference": "obsidian-typings!FileSystemWatchHandler:call(3)", "docComment": "/**\n * Handle file rename events with old and new paths.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "(eventType: " }, { "kind": "Content", "text": "'renamed'" }, { "kind": "Content", "text": ", path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", oldPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "eventType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "oldPath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ] }, { "kind": "CallSignature", "canonicalReference": "obsidian-typings!FileSystemWatchHandler:call(4)", "docComment": "/**\n * Handle watcher closed events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "(eventType: " }, { "kind": "Content", "text": "'closed'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "eventType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FileTreeItem:interface", "docComment": "/**\n * {@link Tree} item representing a file in the file explorer.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileTreeItem extends " }, { "kind": "Reference", "text": "AbstractFileTreeItem", "canonicalReference": "obsidian-typings!AbstractFileTreeItem:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/FileTreeItem.d.ts", "releaseTag": "Public", "name": "FileTreeItem", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FileTreeItem#isSupported:member(1)", "docComment": "/**\n * Check whether the file type is supported for opening.\n *\n * @returns Whether the file type is supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isSupported(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isSupported" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FileTreeItem#tagEl:member", "docComment": "/**\n * Element that indicates associated file extension, if it wasn't a Markdown file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tagEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tagEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!FileTreeItemParent:type", "docComment": "/**\n * Parent type for file tree items: either a folder or the tree root.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type FileTreeItemParent = " }, { "kind": "Reference", "text": "FolderTreeItem", "canonicalReference": "obsidian-typings!FolderTreeItem:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "TreeRoot", "canonicalReference": "obsidian-typings!TreeRoot:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileTreeItem", "canonicalReference": "obsidian-typings!FileTreeItem:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FolderTreeItem", "canonicalReference": "obsidian-typings!FolderTreeItem:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/FileTreeItemParent.d.ts", "releaseTag": "Public", "name": "FileTreeItemParent", "typeTokenRange": { "startIndex": 1, "endIndex": 9 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FlatFunction:interface", "docComment": "/**\n * Function `Flat`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FlatFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/FlatFunction.d.ts", "releaseTag": "Public", "name": "FlatFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FloorFunction:interface", "docComment": "/**\n * Function `Floor`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FloorFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/FloorFunction.d.ts", "releaseTag": "Public", "name": "FloorFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FocusMetadataOptions:interface", "docComment": "/**\n * Options for focusing a specific property or heading in the metadata editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FocusMetadataOptions " } ], "fileUrlPath": "src/obsidian/internals/FocusMetadataOptions.d.ts", "releaseTag": "Public", "name": "FocusMetadataOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FocusMetadataOptions#focusHeading:member", "docComment": "/**\n * Whether to focus the metadata heading element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusHeading: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusHeading", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FocusMetadataOptions#propertyIdx:member", "docComment": "/**\n * Index of the property to focus on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "propertyIdx?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "propertyIdx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FocusMetadataOptions#propertyKey:member", "docComment": "/**\n * Key of the property to focus on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "propertyKey?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "propertyKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!FocusMode:type", "docComment": "/**\n * Specifies which part of an input to focus: start, end, or select both.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type FocusMode = " }, { "kind": "Content", "text": "'both' | 'end' | 'start'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/FocusMode.d.ts", "releaseTag": "Public", "name": "FocusMode", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Fold:interface", "docComment": "/**\n * Represents a folded range in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Fold " } ], "fileUrlPath": "src/obsidian/internals/Fold.d.ts", "releaseTag": "Public", "name": "Fold", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Fold#from:member", "docComment": "/**\n * Start line of the fold.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Fold#to:member", "docComment": "/**\n * End line of the fold.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FolderBookmarkItem:interface", "docComment": "/**\n * {@link Bookmark} item representing a bookmarked folder.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FolderBookmarkItem extends " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/bookmark-items/FolderBookmarkItem.d.ts", "releaseTag": "Public", "name": "FolderBookmarkItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FolderBookmarkItem#path:member", "docComment": "/**\n * Vault-relative path to the bookmarked folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FolderBookmarkItem#type:member", "docComment": "/**\n * Discriminator indicating this is a folder bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'folder'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FolderPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for folders.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FolderPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/FolderPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "FolderPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FolderPropertyWidgetComponent#inputEl:member", "docComment": "/**\n * The input element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FolderPropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FolderPropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FolderPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'folder'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FolderTreeItem:interface", "docComment": "/**\n * {@link Tree} item representing a folder in the file explorer, supporting collapse and child items.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FolderTreeItem extends " }, { "kind": "Reference", "text": "AbstractFileTreeItem", "canonicalReference": "obsidian-typings!AbstractFileTreeItem:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TreeCollapsibleItem", "canonicalReference": "obsidian-typings!TreeCollapsibleItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/file-explorer/FolderTreeItem.d.ts", "releaseTag": "Public", "name": "FolderTreeItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FolderTreeItem#pusherEl:member", "docComment": "/**\n * Spacer element used for indentation in the tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pusherEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pusherEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FolderTreeItem#sort:member(1)", "docComment": "/**\n * Sort file items inside by current sort order.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sort(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "sort" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FolderTreeItem#vChildren:member", "docComment": "/**\n * Virtual children container managing child file and folder tree items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vChildren: " }, { "kind": "Reference", "text": "TreeNodeVChildren", "canonicalReference": "obsidian-typings!TreeNodeVChildren:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileTreeItem", "canonicalReference": "obsidian-typings!FileTreeItem:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FolderTreeItem", "canonicalReference": "obsidian-typings!FolderTreeItem:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FolderTreeItem", "canonicalReference": "obsidian-typings!FolderTreeItem:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vChildren", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 9 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FoldInfo:interface", "docComment": "/**\n * Information about all folds in a document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FoldInfo " } ], "fileUrlPath": "src/obsidian/internals/FoldInfo.d.ts", "releaseTag": "Public", "name": "FoldInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FoldInfo#folds:member", "docComment": "/**\n * Array of folded ranges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "folds: " }, { "kind": "Reference", "text": "Fold", "canonicalReference": "obsidian-typings!Fold:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "folds", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FoldInfo#lines:member", "docComment": "/**\n * Total number of lines in the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lines: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lines", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FoldManager:interface", "docComment": "/**\n * Manager for persisting and restoring editor fold states.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FoldManager " } ], "fileUrlPath": "src/obsidian/internals/FoldManager.d.ts", "releaseTag": "Public", "name": "FoldManager", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FoldManager#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FoldManager#cleanup:member(1)", "docComment": "/**\n * Remove stale fold data from the cache.\n *\n * @returns The result of the cleanup operation. To get the constructor instance, use {@link getFoldManagerConstructor} from `obsidian-typings/implementations`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cleanup(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cleanup" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FoldManager#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getFoldManagerConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FoldManager#load:member(1)", "docComment": "/**\n * Load fold state for the given file or view.\n *\n * @returns The loaded fold state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "load(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "load" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FoldManager#loadPath:member(1)", "docComment": "/**\n * Load fold state from a specific path.\n *\n * @returns The loaded fold state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadPath(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "loadPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FoldManager#save:member(1)", "docComment": "/**\n * Save fold state for the given file or view.\n *\n * @returns The result of the save operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "save(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "save" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FoldManager#savePath:member(1)", "docComment": "/**\n * Save fold state to a specific path.\n *\n * @returns The result of the save operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "savePath(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "savePath" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FootnotesPlugin:interface", "docComment": "/**\n * Internal plugin registration for the footnotes feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FootnotesPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FootnotesPluginInstance", "canonicalReference": "obsidian-typings!FootnotesPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/footnotes/FootnotesPlugin.d.ts", "releaseTag": "Public", "name": "FootnotesPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FootnotesPluginInstance:interface", "docComment": "/**\n * Plugin instance for footnotes, providing footnote creation and navigation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FootnotesPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FootnotesPlugin", "canonicalReference": "obsidian-typings!FootnotesPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/footnotes/FootnotesPluginInstance.d.ts", "releaseTag": "Public", "name": "FootnotesPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FootnotesPluginInstance#initLeaf:member(1)", "docComment": "/**\n * Initialize the footnotes view leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initLeaf(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initLeaf" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!FrameDom:interface", "docComment": "/**\n * DOM elements for the custom window frame (title bar) on desktop.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FrameDom " } ], "fileUrlPath": "src/obsidian/internals/FrameDom.d.ts", "releaseTag": "Public", "name": "FrameDom", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FrameDom#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getFrameDomConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param electronWindow - The electronWindow.\n *\n * @param win - The win.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(electronWindow: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ", win: " }, { "kind": "Reference", "text": "Window", "canonicalReference": "!Window:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "electronWindow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "win", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FrameDom#eWin:member", "docComment": "/**\n * Reference to the Electron browser window.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eWin: " }, { "kind": "Reference", "text": "ElectronBrowserWindow", "canonicalReference": "obsidian-typings!ElectronBrowserWindow:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "eWin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FrameDom#isMac:member", "docComment": "/**\n * Whether the current platform is macOS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMac: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMac", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FrameDom#leftButtonContainerEl:member", "docComment": "/**\n * Container for window control buttons on the left side.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "leftButtonContainerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "leftButtonContainerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FrameDom#requestUpdateStatus:member", "docComment": "/**\n * Debounced request to update the window status indicators in the title bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestUpdateStatus: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestUpdateStatus", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FrameDom#titleBarEl:member", "docComment": "/**\n * The title bar element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "titleBarEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "titleBarEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FrameDom#titleBarInnerEl:member", "docComment": "/**\n * Inner container of the title bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "titleBarInnerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "titleBarInnerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FrameDom#titleBarTextEl:member", "docComment": "/**\n * Element displaying the title bar text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "titleBarTextEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "titleBarTextEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FrameDom#updateStatus:member(1)", "docComment": "/**\n * Update the window status indicators in the title bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateStatus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateStatus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!FrameDom#updateTitle:member(1)", "docComment": "/**\n * Update the displayed title in the title bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateTitle(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateTitle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!FrameDom#win:member", "docComment": "/**\n * Reference to the window object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "win: " }, { "kind": "Reference", "text": "Window", "canonicalReference": "!Window:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "win", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!fromTextArea:function(1)", "docComment": "/**\n * Creates a CodeMirror 5 editor from a textarea element.\n *\n * @param host - The textarea element to replace.\n *\n * @param options - Optional editor configuration.\n *\n * @returns The created editor instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function fromTextArea(host: " }, { "kind": "Reference", "text": "HTMLTextAreaElement", "canonicalReference": "!HTMLTextAreaElement:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Cm5EditorConfiguration", "canonicalReference": "obsidian-typings!Cm5EditorConfiguration:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/fromTextArea.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "host", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "fromTextArea" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getAbstractTextComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#AbstractTextComponent} constructor.\n *\n * @returns The {@link obsidian#AbstractTextComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getAbstractTextComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AbstractTextComponent", "canonicalReference": "obsidian!AbstractTextComponent:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "HTMLTextAreaElement", "canonicalReference": "!HTMLTextAreaElement:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getAbstractTextComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAbstractTextComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getAllPropertiesViewConstructor:function(1)", "docComment": "/**\n * Get the {@link AllPropertiesView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link AllPropertiesView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getAllPropertiesViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AllPropertiesView", "canonicalReference": "obsidian-typings!AllPropertiesView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getAllPropertiesViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getAllPropertiesViewConstructor" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GetAnnotationsParams:interface", "docComment": "/**\n * Parameters for getting page annotations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GetAnnotationsParams " } ], "fileUrlPath": "src/pdfjs-dist/internals/GetAnnotationsParams.d.ts", "releaseTag": "Public", "name": "GetAnnotationsParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetAnnotationsParams#intent:member", "docComment": "/**\n * The rendering intent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "intent?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "intent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!getAppConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#App} constructor.\n *\n * @returns The {@link obsidian#App} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getAppConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getAppConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAppConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getAppMenuBarManagerConstructor:function(1)", "docComment": "/**\n * Get the {@link AppMenuBarManager} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link AppMenuBarManager} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getAppMenuBarManagerConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AppMenuBarManager", "canonicalReference": "obsidian-typings!AppMenuBarManager:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getAppMenuBarManagerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getAppMenuBarManagerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getAppSettingConstructor:function(1)", "docComment": "/**\n * Get the {@link AppSetting} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link AppSetting} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getAppSettingConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AppSetting", "canonicalReference": "obsidian-typings!AppSetting:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getAppSettingConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getAppSettingConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getAudioViewConstructor:function(1)", "docComment": "/**\n * Get the {@link AudioView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link AudioView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getAudioViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AudioView", "canonicalReference": "obsidian-typings!AudioView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getAudioViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getAudioViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBacklinkViewConstructor:function(1)", "docComment": "/**\n * Get the {@link BacklinkView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link BacklinkView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBacklinkViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BacklinkView", "canonicalReference": "obsidian-typings!BacklinkView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getBacklinkViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getBacklinkViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBaseComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#BaseComponent} constructor.\n *\n * @returns The {@link obsidian#BaseComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBaseComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BaseComponent", "canonicalReference": "obsidian!BaseComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getBaseComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBaseComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBasesContextConstructor:function(1)", "docComment": "/**\n * Get the {@link BasesContext} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link BasesContext} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBasesContextConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesContext", "canonicalReference": "obsidian-typings!BasesContext:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/internal-plugins/bases/getBasesContextConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getBasesContextConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBasesControllerFromRender:function(1)", "docComment": "/**\n * Render a base into a detached, off-screen element and return the live {@link BasesController} that drives it. This is the leaf-free route to headless base evaluation: it runs Obsidian's own base-embed processor via the public {@link obsidian#MarkdownRenderer.render}, then locates the controller in the render's component tree.\n *\n * The caller owns `component`'s lifecycle and MUST call `component.unload()` once done with the controller (which also detaches the rendered element).\n *\n * @param app - The app instance.\n *\n * @param content - The `.base` file content (the body of a `base` code block).\n *\n * @param sourcePath - The path supplying the query's file context.\n *\n * @param component - The component that owns the render; the caller unloads it.\n *\n * @returns The live {@link BasesController} for the rendered base.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBasesControllerFromRender(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", sourcePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", component: " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesController", "canonicalReference": "obsidian-typings!BasesController:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/functions/getBasesControllerFromRender.d.ts", "returnTypeTokenRange": { "startIndex": 9, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "sourcePath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "component", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "getBasesControllerFromRender" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBasesEntryConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#BasesEntry} constructor.\n *\n * @returns The {@link obsidian#BasesEntry} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBasesEntryConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesEntry", "canonicalReference": "obsidian!BasesEntry:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/bases/getBasesEntryConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBasesEntryConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBasesEntryGroupConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#BasesEntryGroup} constructor.\n *\n * @returns The {@link obsidian#BasesEntryGroup} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBasesEntryGroupConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesEntryGroup", "canonicalReference": "obsidian!BasesEntryGroup:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/bases/getBasesEntryGroupConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBasesEntryGroupConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBasesQueryConstructor:function(1)", "docComment": "/**\n * Get the {@link BasesQuery} constructor (the `.base` parser, exposing the static `fromString`).\n *\n * `BasesQuery` has no public `obsidian` export and no leaf-free factory, so the class is harvested at runtime: a throwaway base is rendered off-screen (via {@link getBasesControllerFromRender}) and the constructor is read off the resulting query. The throwaway render is torn down before returning.\n *\n * @param app - The app instance.\n *\n * @returns The {@link BasesQuery} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBasesQueryConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesQueryConstructor", "canonicalReference": "obsidian-typings!BasesQueryConstructor:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/internal-plugins/bases/getBasesQueryConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getBasesQueryConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBasesQueryResultConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#BasesQueryResult} constructor.\n *\n * @returns The {@link obsidian#BasesQueryResult} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBasesQueryResultConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesQueryResult", "canonicalReference": "obsidian!BasesQueryResult:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/bases/getBasesQueryResultConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBasesQueryResultConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBasesViewConfigConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#BasesViewConfig} constructor.\n *\n * @returns The {@link obsidian#BasesViewConfig} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBasesViewConfigConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesViewConfig", "canonicalReference": "obsidian!BasesViewConfig:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/bases/getBasesViewConfigConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBasesViewConfigConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBasesViewConstructor:function(1)", "docComment": "/**\n * Get the {@link BasesView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link BasesView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBasesViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BasesView", "canonicalReference": "obsidian-typings!BasesView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getBasesViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getBasesViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBookmarksViewConstructor:function(1)", "docComment": "/**\n * Get the {@link BookmarksView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link BookmarksView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBookmarksViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BookmarksView", "canonicalReference": "obsidian-typings!BookmarksView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getBookmarksViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getBookmarksViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getBooleanValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#BooleanValue} constructor.\n *\n * @returns The {@link obsidian#BooleanValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getBooleanValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BooleanValue", "canonicalReference": "obsidian-typings!~BooleanValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getBooleanValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBooleanValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getButtonComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ButtonComponent} constructor.\n *\n * @returns The {@link obsidian#ButtonComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getButtonComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ButtonComponent", "canonicalReference": "obsidian!ButtonComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getButtonComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getButtonComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getCanvasViewConstructor:function(1)", "docComment": "/**\n * Get the {@link CanvasView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link CanvasView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getCanvasViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CanvasView", "canonicalReference": "obsidian-typings!CanvasView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getCanvasViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getCanvasViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getCapacitorAdapterConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#CapacitorAdapter} constructor.\n *\n * @returns The {@link obsidian#CapacitorAdapter} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getCapacitorAdapterConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CapacitorAdapter", "canonicalReference": "obsidian!CapacitorAdapter:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getCapacitorAdapterConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCapacitorAdapterConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getCliConstructor:function(1)", "docComment": "/**\n * Get the {@link Cli} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link Cli} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getCliConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Cli", "canonicalReference": "obsidian-typings!Cli:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getCliConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getCliConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getColorComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ColorComponent} constructor.\n *\n * @returns The {@link obsidian#ColorComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getColorComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorComponent", "canonicalReference": "obsidian!ColorComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getColorComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getColorComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getCommandsConstructor:function(1)", "docComment": "/**\n * Get the {@link Commands} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link Commands} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getCommandsConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Commands", "canonicalReference": "obsidian-typings!Commands:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getCommandsConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getCommandsConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Component} constructor.\n *\n * @returns The {@link obsidian#Component} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getCustomCSSConstructor:function(1)", "docComment": "/**\n * Get the {@link CustomCSS} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link CustomCSS} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getCustomCSSConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CustomCSS", "canonicalReference": "obsidian-typings!CustomCSS:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getCustomCSSConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getCustomCSSConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getDataAdapterEx:function(1)", "docComment": "/**\n * Get the instance of the current {@link DataAdapterEx}.\n *\n * @param app - The application instance.\n *\n * @returns The data adapter extension.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getDataAdapterEx(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "DataAdapterEx", "canonicalReference": "obsidian-typings!DataAdapterEx:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/functions/getDataAdapterEx.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDataAdapterEx" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getDateValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#DateValue} constructor.\n *\n * @returns The {@link obsidian#DateValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getDateValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DateValue", "canonicalReference": "obsidian-typings!~DateValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getDateValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDateValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getDocument:function(1)", "docComment": "/**\n * Loads a PDF document from the given source.\n *\n * @param src - The document source (URL, ArrayBuffer, DocumentInitParameters, string, or Uint8Array).\n *\n * @returns The loading task for the document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getDocument(src: " }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DocumentInitParameters", "canonicalReference": "obsidian-typings!DocumentInitParameters:interface" }, { "kind": "Content", "text": " | string | " }, { "kind": "Reference", "text": "Uint8Array", "canonicalReference": "!Uint8Array:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "URL", "canonicalReference": "!URL:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PDFDocumentLoadingTask", "canonicalReference": "obsidian-typings!PDFDocumentLoadingTask:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pdfjs-dist/internals/functions/getDocument.d.ts", "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "src", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 8 }, "isOptional": false } ], "name": "getDocument" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getDragManagerConstructor:function(1)", "docComment": "/**\n * Get the {@link DragManager} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link DragManager} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getDragManagerConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DragManager", "canonicalReference": "obsidian-typings!DragManager:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getDragManagerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDragManagerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getDropdownComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#DropdownComponent} constructor.\n *\n * @returns The {@link obsidian#DropdownComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getDropdownComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DropdownComponent", "canonicalReference": "obsidian!DropdownComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getDropdownComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDropdownComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getDurationValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#DurationValue} constructor.\n *\n * @returns The {@link obsidian#DurationValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getDurationValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DurationValue", "canonicalReference": "obsidian-typings!~DurationValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getDurationValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDurationValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getEditableFileViewConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#EditableFileView} constructor.\n *\n * @returns The {@link obsidian#EditableFileView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getEditableFileViewConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EditableFileView", "canonicalReference": "obsidian!EditableFileView:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/views/getEditableFileViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getEditableFileViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getEditorConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Editor} constructor.\n *\n * @returns The {@link obsidian#Editor} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getEditorConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getEditorConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getEditorConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getEditorSuggestsConstructor:function(1)", "docComment": "/**\n * Get the {@link EditorSuggests} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link EditorSuggests} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getEditorSuggestsConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EditorSuggests", "canonicalReference": "obsidian-typings!EditorSuggests:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getEditorSuggestsConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getEditorSuggestsConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getEmbedRegistryConstructor:function(1)", "docComment": "/**\n * Get the {@link EmbedRegistry} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link EmbedRegistry} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getEmbedRegistryConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EmbedRegistry", "canonicalReference": "obsidian-typings!EmbedRegistry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getEmbedRegistryConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getEmbedRegistryConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getEmptyViewConstructor:function(1)", "docComment": "/**\n * Get the {@link EmptyView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link EmptyView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getEmptyViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EmptyView", "canonicalReference": "obsidian-typings!EmptyView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getEmptyViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getEmptyViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getEventsConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Events} constructor.\n *\n * @returns The {@link obsidian#Events} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getEventsConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getEventsConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getEventsConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getExtraButtonComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ExtraButtonComponent} constructor.\n *\n * @returns The {@link obsidian#ExtraButtonComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getExtraButtonComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ExtraButtonComponent", "canonicalReference": "obsidian!ExtraButtonComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getExtraButtonComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getExtraButtonComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getFileExplorerViewConstructor:function(1)", "docComment": "/**\n * Get the {@link FileExplorerView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link FileExplorerView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFileExplorerViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileExplorerView", "canonicalReference": "obsidian-typings!FileExplorerView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getFileExplorerViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFileExplorerViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getFileManagerConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#FileManager} constructor.\n *\n * @returns The {@link obsidian#FileManager} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFileManagerConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileManager", "canonicalReference": "obsidian!FileManager:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getFileManagerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFileManagerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getFilePropertiesViewConstructor:function(1)", "docComment": "/**\n * Get the {@link FilePropertiesView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link FilePropertiesView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFilePropertiesViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FilePropertiesView", "canonicalReference": "obsidian-typings!FilePropertiesView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getFilePropertiesViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFilePropertiesViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getFileSystemAdapterConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#FileSystemAdapter} constructor.\n *\n * @returns The {@link obsidian#FileSystemAdapter} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFileSystemAdapterConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileSystemAdapter", "canonicalReference": "obsidian-typings!~FileSystemAdapter" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getFileSystemAdapterConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFileSystemAdapterConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getFileValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#FileValue} constructor.\n *\n * @returns The {@link obsidian#FileValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFileValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileValue", "canonicalReference": "obsidian!FileValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getFileValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFileValueConstructor" }, { "kind": "Variable", "canonicalReference": "obsidian-typings!getFixedT:var", "docComment": "/**\n * Gets a translation function fixed to a language and namespace.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFixedT: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['getFixedT']" } ], "fileUrlPath": "src/i18next/internals/functions/getFixedT.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "getFixedT", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Function", "canonicalReference": "obsidian-typings!getFoldManagerConstructor:function(1)", "docComment": "/**\n * Get the {@link FoldManager} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link FoldManager} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFoldManagerConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FoldManager", "canonicalReference": "obsidian-typings!FoldManager:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getFoldManagerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFoldManagerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getFrameDomConstructor:function(1)", "docComment": "/**\n * Get the {@link FrameDom} constructor.\n *\n * @returns The {@link FrameDom} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFrameDomConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FrameDom", "canonicalReference": "obsidian-typings!FrameDom:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getFrameDomConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFrameDomConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getFuzzySuggestModalConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#FuzzySuggestModal} constructor.\n *\n * @returns The {@link obsidian#FuzzySuggestModal} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFuzzySuggestModalConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FuzzySuggestModal", "canonicalReference": "obsidian!FuzzySuggestModal:class" }, { "kind": "Content", "text": "<unknown>>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getFuzzySuggestModalConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFuzzySuggestModalConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getGraphViewConstructor:function(1)", "docComment": "/**\n * Get the {@link GraphView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link GraphView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getGraphViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GraphView", "canonicalReference": "obsidian-typings!GraphView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getGraphViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getGraphViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getHotkeyManagerConstructor:function(1)", "docComment": "/**\n * Get the {@link HotkeyManager} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link HotkeyManager} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getHotkeyManagerConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HotkeyManager", "canonicalReference": "obsidian-typings!HotkeyManager:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getHotkeyManagerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getHotkeyManagerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getHoverPopoverConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#HoverPopover} constructor.\n *\n * @returns The {@link obsidian#HoverPopover} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getHoverPopoverConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HoverPopover", "canonicalReference": "obsidian!HoverPopover:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getHoverPopoverConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getHoverPopoverConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getHTMLValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#HTMLValue} constructor.\n *\n * @returns The {@link obsidian#HTMLValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getHTMLValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HTMLValue", "canonicalReference": "obsidian!HTMLValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getHTMLValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getHTMLValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getIconValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#IconValue} constructor.\n *\n * @returns The {@link obsidian#IconValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getIconValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IconValue", "canonicalReference": "obsidian!IconValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getIconValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getIconValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getImageValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ImageValue} constructor.\n *\n * @returns The {@link obsidian#ImageValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getImageValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ImageValue", "canonicalReference": "obsidian!ImageValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getImageValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getImageValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getImageViewConstructor:function(1)", "docComment": "/**\n * Get the {@link ImageView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link ImageView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getImageViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ImageView", "canonicalReference": "obsidian-typings!ImageView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getImageViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getImageViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getInternalPluginConstructor:function(1)", "docComment": "/**\n * Get the {@link InternalPlugin} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link InternalPlugin} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getInternalPluginConstructor<Instance>(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<Instance>>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/internal-plugins/getInternalPluginConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "Instance", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "getInternalPluginConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getInternalPluginsConstructor:function(1)", "docComment": "/**\n * Get the {@link InternalPlugins} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link InternalPlugins} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getInternalPluginsConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InternalPlugins", "canonicalReference": "obsidian-typings!InternalPlugins:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/internal-plugins/getInternalPluginsConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getInternalPluginsConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getKeymapConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Keymap} constructor.\n *\n * @returns The {@link obsidian#Keymap} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getKeymapConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Keymap", "canonicalReference": "obsidian-typings!~Keymap" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getKeymapConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getKeymapConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getLinkValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#LinkValue} constructor.\n *\n * @returns The {@link obsidian#LinkValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getLinkValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "LinkValue", "canonicalReference": "obsidian-typings!~LinkValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getLinkValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLinkValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getListValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ListValue} constructor.\n *\n * @returns The {@link obsidian#ListValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getListValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ListValue", "canonicalReference": "obsidian-typings!~ListValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getListValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getListValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getLocalGraphViewConstructor:function(1)", "docComment": "/**\n * Get the {@link LocalGraphView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link LocalGraphView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getLocalGraphViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "LocalGraphView", "canonicalReference": "obsidian-typings!LocalGraphView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getLocalGraphViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getLocalGraphViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMarkdownPreviewRendererConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MarkdownPreviewRenderer} constructor.\n *\n * @returns The {@link obsidian#MarkdownPreviewRenderer} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMarkdownPreviewRendererConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MarkdownPreviewRenderer", "canonicalReference": "obsidian-typings!~MarkdownPreviewRenderer" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getMarkdownPreviewRendererConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMarkdownPreviewRendererConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMarkdownPreviewViewConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MarkdownPreviewView} constructor.\n *\n * @returns The {@link obsidian#MarkdownPreviewView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMarkdownPreviewViewConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MarkdownPreviewView", "canonicalReference": "obsidian!MarkdownPreviewView:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getMarkdownPreviewViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMarkdownPreviewViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMarkdownRenderChildConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MarkdownRenderChild} constructor.\n *\n * @returns The {@link obsidian#MarkdownRenderChild} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMarkdownRenderChildConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MarkdownRenderChild", "canonicalReference": "obsidian!MarkdownRenderChild:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getMarkdownRenderChildConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMarkdownRenderChildConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMarkdownRendererConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MarkdownRenderer} constructor.\n *\n * @returns The {@link obsidian#MarkdownRenderer} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMarkdownRendererConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MarkdownRenderer", "canonicalReference": "obsidian-typings!~MarkdownRenderer" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getMarkdownRendererConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMarkdownRendererConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMarkdownViewConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MarkdownView} constructor.\n *\n * @returns The {@link obsidian#MarkdownView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMarkdownViewConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MarkdownView", "canonicalReference": "obsidian!MarkdownView:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/views/getMarkdownViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMarkdownViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMenuConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Menu} constructor.\n *\n * @returns The {@link obsidian#Menu} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMenuConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getMenuConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMenuConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMenuItemConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MenuItem} constructor.\n *\n * @returns The {@link obsidian#MenuItem} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMenuItemConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MenuItem", "canonicalReference": "obsidian!MenuItem:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getMenuItemConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMenuItemConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMenuSeparatorConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MenuSeparator} constructor.\n *\n * @returns The {@link obsidian#MenuSeparator} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMenuSeparatorConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MenuSeparator", "canonicalReference": "obsidian!MenuSeparator:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getMenuSeparatorConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMenuSeparatorConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMetadataCacheConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MetadataCache} constructor.\n *\n * @returns The {@link obsidian#MetadataCache} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMetadataCacheConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MetadataCache", "canonicalReference": "obsidian!MetadataCache:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getMetadataCacheConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMetadataCacheConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMetadataTypeManagerConstructor:function(1)", "docComment": "/**\n * Get the {@link MetadataTypeManager} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link MetadataTypeManager} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMetadataTypeManagerConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MetadataTypeManager", "canonicalReference": "obsidian-typings!MetadataTypeManager:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getMetadataTypeManagerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getMetadataTypeManagerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getModalConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Modal} constructor.\n *\n * @returns The {@link obsidian#Modal} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getModalConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Modal", "canonicalReference": "obsidian!Modal:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getModalConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getModalConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getMomentFormatComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#MomentFormatComponent} constructor.\n *\n * @returns The {@link obsidian#MomentFormatComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMomentFormatComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MomentFormatComponent", "canonicalReference": "obsidian!MomentFormatComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getMomentFormatComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMomentFormatComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getNoticeConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Notice} constructor.\n *\n * @returns The {@link obsidian#Notice} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getNoticeConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Notice", "canonicalReference": "obsidian!Notice:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getNoticeConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getNoticeConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getNotNullValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#NotNullValue} constructor.\n *\n * @returns The {@link obsidian#NotNullValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getNotNullValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NotNullValue", "canonicalReference": "obsidian!NotNullValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getNotNullValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getNotNullValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getNullValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#NullValue} constructor.\n *\n * @returns The {@link obsidian#NullValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getNullValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NullValue", "canonicalReference": "obsidian-typings!~NullValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getNullValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getNullValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getNumberValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#NumberValue} constructor.\n *\n * @returns The {@link obsidian#NumberValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getNumberValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NumberValue", "canonicalReference": "obsidian-typings!~NumberValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getNumberValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getNumberValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getObjectValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ObjectValue} constructor.\n *\n * @returns The {@link obsidian#ObjectValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getObjectValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ObjectValue", "canonicalReference": "obsidian-typings!~ObjectValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getObjectValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getObjectValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getObsidianDOMConstructor:function(1)", "docComment": "/**\n * Get the {@link ObsidianDOM} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link ObsidianDOM} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getObsidianDOMConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ObsidianDOM", "canonicalReference": "obsidian-typings!ObsidianDOM:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getObsidianDOMConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getObsidianDOMConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getOutgoingLinkViewConstructor:function(1)", "docComment": "/**\n * Get the {@link OutgoingLinkView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link OutgoingLinkView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getOutgoingLinkViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "OutgoingLinkView", "canonicalReference": "obsidian-typings!OutgoingLinkView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getOutgoingLinkViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getOutgoingLinkViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getOutlineViewConstructor:function(1)", "docComment": "/**\n * Get the {@link OutlineView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link OutlineView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getOutlineViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "OutlineView", "canonicalReference": "obsidian-typings!OutlineView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getOutlineViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getOutlineViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getPdfViewConstructor:function(1)", "docComment": "/**\n * Get the {@link PdfView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link PdfView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getPdfViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PdfView", "canonicalReference": "obsidian-typings!PdfView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getPdfViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPdfViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getPluginsConstructor:function(1)", "docComment": "/**\n * Get the {@link Plugins} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link Plugins} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getPluginsConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Plugins", "canonicalReference": "obsidian-typings!Plugins:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getPluginsConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPluginsConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getProgressBarComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ProgressBarComponent} constructor.\n *\n * @returns The {@link obsidian#ProgressBarComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getProgressBarComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ProgressBarComponent", "canonicalReference": "obsidian!ProgressBarComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getProgressBarComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getProgressBarComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getQueryControllerConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#QueryController} constructor.\n *\n * @returns The {@link obsidian#QueryController} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getQueryControllerConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "QueryController", "canonicalReference": "obsidian!QueryController:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/bases/getQueryControllerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getQueryControllerConstructor" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GetRecentFilesOptions:interface", "docComment": "/**\n * Options for getting recent files.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GetRecentFilesOptions " } ], "fileUrlPath": "src/obsidian/internals/GetRecentFilesOptions.d.ts", "releaseTag": "Public", "name": "GetRecentFilesOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetRecentFilesOptions#maxCount:member", "docComment": "/**\n * The maximum number of files to return.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxCount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetRecentFilesOptions#showCanvas:member", "docComment": "/**\n * Whether to show canvas files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showCanvas?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showCanvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetRecentFilesOptions#showImages:member", "docComment": "/**\n * Whether to show image files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showImages?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showImages", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetRecentFilesOptions#showMarkdown:member", "docComment": "/**\n * Whether to show markdown files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMarkdown?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showMarkdown", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetRecentFilesOptions#showNonAttachments:member", "docComment": "/**\n * Whether to show non-attachments (canvas, base).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showNonAttachments?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showNonAttachments", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetRecentFilesOptions#showNonImageAttachments:member", "docComment": "/**\n * Whether to show non-image attachments.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showNonImageAttachments?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showNonImageAttachments", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!getRecentFileTrackerConstructor:function(1)", "docComment": "/**\n * Get the {@link RecentFileTracker} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link RecentFileTracker} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getRecentFileTrackerConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RecentFileTracker", "canonicalReference": "obsidian-typings!RecentFileTracker:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getRecentFileTrackerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getRecentFileTrackerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getRegExpValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#RegExpValue} constructor.\n *\n * @returns The {@link obsidian#RegExpValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getRegExpValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RegExpValue", "canonicalReference": "obsidian!RegExpValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getRegExpValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getRegExpValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getRelativeDateValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#RelativeDateValue} constructor.\n *\n * @returns The {@link obsidian#RelativeDateValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getRelativeDateValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RelativeDateValue", "canonicalReference": "obsidian!RelativeDateValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getRelativeDateValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getRelativeDateValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getReleaseNotesViewConstructor:function(1)", "docComment": "/**\n * Get the {@link ReleaseNotesView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link ReleaseNotesView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getReleaseNotesViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ReleaseNotesView", "canonicalReference": "obsidian-typings!ReleaseNotesView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getReleaseNotesViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getReleaseNotesViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getRenderContextConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#RenderContext} constructor.\n *\n * @returns The {@link obsidian#RenderContext} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getRenderContextConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RenderContext", "canonicalReference": "obsidian!RenderContext:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getRenderContextConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getRenderContextConstructor" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GetResourceOptions:interface", "docComment": "/**\n * Options for getting a single resource value.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GetResourceOptions " } ], "fileUrlPath": "src/i18next/internals/GetResourceOptions.d.ts", "releaseTag": "Public", "name": "GetResourceOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetResourceOptions#keySeparator:member", "docComment": "/**\n * Custom key separator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keySeparator?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "keySeparator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!getScopeConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Scope} constructor.\n *\n * @returns The {@link obsidian#Scope} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getScopeConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Scope", "canonicalReference": "obsidian!Scope:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getScopeConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getScopeConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSearchComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#SearchComponent} constructor.\n *\n * @returns The {@link obsidian#SearchComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSearchComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchComponent", "canonicalReference": "obsidian!SearchComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getSearchComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSearchComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSearchViewConstructor:function(1)", "docComment": "/**\n * Get the {@link SearchView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link SearchView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSearchViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchView", "canonicalReference": "obsidian-typings!SearchView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getSearchViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSearchViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSecretComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#SecretComponent} constructor.\n *\n * @returns The {@link obsidian#SecretComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSecretComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SecretComponent", "canonicalReference": "obsidian!SecretComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getSecretComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSecretComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSecretStorageConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#SecretStorage} constructor.\n *\n * @returns The {@link obsidian#SecretStorage} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSecretStorageConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SecretStorage", "canonicalReference": "obsidian!SecretStorage:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getSecretStorageConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSecretStorageConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSettingConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Setting} constructor.\n *\n * @returns The {@link obsidian#Setting} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSettingConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Setting", "canonicalReference": "obsidian!Setting:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getSettingConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSettingConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSettingGroupConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#SettingGroup} constructor.\n *\n * @returns The {@link obsidian#SettingGroup} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSettingGroupConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SettingGroup", "canonicalReference": "obsidian!SettingGroup:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getSettingGroupConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSettingGroupConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSettingTabConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#SettingTab} constructor.\n *\n * @returns The {@link obsidian#SettingTab} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSettingTabConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getSettingTabConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSettingTabConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getShareReceiverConstructor:function(1)", "docComment": "/**\n * Get the {@link ShareReceiver} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link ShareReceiver} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getShareReceiverConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ShareReceiver", "canonicalReference": "obsidian-typings!ShareReceiver:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getShareReceiverConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getShareReceiverConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSliderComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#SliderComponent} constructor.\n *\n * @returns The {@link obsidian#SliderComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSliderComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SliderComponent", "canonicalReference": "obsidian!SliderComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getSliderComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSliderComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getStatusBarConstructor:function(1)", "docComment": "/**\n * Get the {@link StatusBar} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link StatusBar} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getStatusBarConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StatusBar", "canonicalReference": "obsidian-typings!StatusBar:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getStatusBarConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getStatusBarConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getStringValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#StringValue} constructor.\n *\n * @returns The {@link obsidian#StringValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getStringValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StringValue", "canonicalReference": "obsidian-typings!~StringValue" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getStringValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getStringValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getSyncViewConstructor:function(1)", "docComment": "/**\n * Get the {@link SyncView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link SyncView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getSyncViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SyncView", "canonicalReference": "obsidian-typings!SyncView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getSyncViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSyncViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTableViewConstructor:function(1)", "docComment": "/**\n * Get the {@link TableView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link TableView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTableViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TableView", "canonicalReference": "obsidian-typings!TableView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getTableViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getTableViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTAbstractFileConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#TAbstractFile} constructor.\n *\n * @returns The {@link obsidian#TAbstractFile} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTAbstractFileConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getTAbstractFileConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTAbstractFileConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTagValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#TagValue} constructor.\n *\n * @returns The {@link obsidian#TagValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTagValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TagValue", "canonicalReference": "obsidian!TagValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getTagValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTagValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTagViewConstructor:function(1)", "docComment": "/**\n * Get the {@link TagView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link TagView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTagViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TagView", "canonicalReference": "obsidian-typings!TagView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getTagViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getTagViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTasksConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Tasks} constructor.\n *\n * @returns The {@link obsidian#Tasks} constructor.\n *\n * @remark\n *\n * Constructor is `null`. See {@link https://forum.obsidian.md/t/api-bug-tasks-class/98993}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTasksConstructor(): " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<[], " }, { "kind": "Reference", "text": "Tasks", "canonicalReference": "obsidian!Tasks:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getTasksConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTasksConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTextAreaComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#TextAreaComponent} constructor.\n *\n * @returns The {@link obsidian#TextAreaComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTextAreaComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TextAreaComponent", "canonicalReference": "obsidian!TextAreaComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getTextAreaComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTextAreaComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTextComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#TextComponent} constructor.\n *\n * @returns The {@link obsidian#TextComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTextComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TextComponent", "canonicalReference": "obsidian!TextComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getTextComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTextComponentConstructor" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GetTextContentParams:interface", "docComment": "/**\n * Parameters for getting page text content.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GetTextContentParams " } ], "fileUrlPath": "src/pdfjs-dist/internals/GetTextContentParams.d.ts", "releaseTag": "Public", "name": "GetTextContentParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetTextContentParams#disableNormalization:member", "docComment": "/**\n * Whether to disable text normalization.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableNormalization?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableNormalization", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetTextContentParams#includeMarkedContent:member", "docComment": "/**\n * Whether to include marked content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "includeMarkedContent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "includeMarkedContent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTFileConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#TFile} constructor.\n *\n * @returns The {@link obsidian#TFile} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTFileConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getTFileConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTFileConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getTFolderConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#TFolder} constructor.\n *\n * @returns The {@link obsidian#TFolder} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getTFolderConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFolder", "canonicalReference": "obsidian!TFolder:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getTFolderConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTFolderConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getToggleComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ToggleComponent} constructor.\n *\n * @returns The {@link obsidian#ToggleComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getToggleComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ToggleComponent", "canonicalReference": "obsidian!ToggleComponent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getToggleComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getToggleComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getUrlValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#UrlValue} constructor.\n *\n * @returns The {@link obsidian#UrlValue} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getUrlValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "UrlValue", "canonicalReference": "obsidian!UrlValue:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getUrlValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getUrlValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getValueComponentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#ValueComponent} constructor.\n *\n * @returns The {@link obsidian#ValueComponent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getValueComponentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ValueComponent", "canonicalReference": "obsidian!ValueComponent:class" }, { "kind": "Content", "text": "<unknown>>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/settings/setting-components/getValueComponentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getValueComponentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getValueConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Value} constructor.\n *\n * @returns The {@link obsidian#Value} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getValueConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Value", "canonicalReference": "obsidian-typings!~Value" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/values/getValueConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getValueConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getVaultConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Vault} constructor.\n *\n * @returns The {@link obsidian#Vault} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getVaultConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Vault", "canonicalReference": "obsidian-typings!~Vault" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getVaultConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getVaultConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getVideoViewConstructor:function(1)", "docComment": "/**\n * Get the {@link VideoView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link VideoView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getVideoViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "VideoView", "canonicalReference": "obsidian-typings!VideoView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getVideoViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getVideoViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getViewConstructorByViewType:function(1)", "docComment": "/**\n * Get the view constructor by view type.\n *\n * @param app - The app.\n *\n * @param viewType - The view type.\n *\n * @returns The view constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getViewConstructorByViewType<TViewType extends " }, { "kind": "Reference", "text": "ViewTypeType", "canonicalReference": "obsidian-typings!ViewTypeType:type" }, { "kind": "Content", "text": ">(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", viewType: " }, { "kind": "Content", "text": "TViewType" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ViewTypeViewMapping", "canonicalReference": "obsidian-typings!ViewTypeViewMapping:type" }, { "kind": "Content", "text": "[TViewType]>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getViewConstructorByViewType.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "viewType", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "TViewType", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "getViewConstructorByViewType" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GetViewportParams:interface", "docComment": "/**\n * Parameters for computing a page viewport.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GetViewportParams " } ], "fileUrlPath": "src/pdfjs-dist/internals/GetViewportParams.d.ts", "releaseTag": "Public", "name": "GetViewportParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetViewportParams#dontFlip:member", "docComment": "/**\n * Whether to flip the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dontFlip?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "dontFlip", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetViewportParams#offsetX:member", "docComment": "/**\n * Horizontal offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offsetX?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "offsetX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetViewportParams#offsetY:member", "docComment": "/**\n * Vertical offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offsetY?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "offsetY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetViewportParams#rotation:member", "docComment": "/**\n * Rotation angle in degrees.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotation?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rotation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GetViewportParams#scale:member", "docComment": "/**\n * Scale factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!getViewRegistryConstructor:function(1)", "docComment": "/**\n * Get the {@link ViewRegistry} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link ViewRegistry} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getViewRegistryConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ViewRegistry", "canonicalReference": "obsidian-typings!ViewRegistry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getViewRegistryConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getViewRegistryConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWebviewerHistoryViewConstructor:function(1)", "docComment": "/**\n * Get the {@link WebviewerHistoryView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link WebviewerHistoryView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWebviewerHistoryViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WebviewerHistoryView", "canonicalReference": "obsidian-typings!WebviewerHistoryView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getWebviewerHistoryViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getWebviewerHistoryViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWebviewerViewConstructor:function(1)", "docComment": "/**\n * Get the {@link WebviewerView} constructor.\n *\n * @param app - The app.\n *\n * @returns The {@link WebviewerView} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWebviewerViewConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WebviewerView", "canonicalReference": "obsidian-typings!WebviewerView:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/views/getWebviewerViewConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getWebviewerViewConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#Workspace} constructor.\n *\n * @returns The {@link obsidian#Workspace} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Workspace", "canonicalReference": "obsidian!Workspace:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceContainerConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceContainer} constructor.\n *\n * @returns The {@link obsidian#WorkspaceContainer} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceContainerConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceContainer", "canonicalReference": "obsidian!WorkspaceContainer:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceContainerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceContainerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceFloatingConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceFloating} constructor.\n *\n * @returns The {@link obsidian#WorkspaceFloating} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceFloatingConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceFloating", "canonicalReference": "obsidian!WorkspaceFloating:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceFloatingConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceFloatingConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceItemConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceItem} constructor.\n *\n * @returns The {@link obsidian#WorkspaceItem} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceItemConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceItem", "canonicalReference": "obsidian!WorkspaceItem:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceItemConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceItemConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceLeafConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceLeaf} constructor.\n *\n * @returns The {@link obsidian#WorkspaceLeaf} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceLeafConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceLeafConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceLeafConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceLeafHistoryConstructor:function(1)", "docComment": "/**\n * Get the {@link WorkspaceLeafHistory} constructor.\n *\n * @param app - The app instance.\n *\n * @returns The {@link WorkspaceLeafHistory} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceLeafHistoryConstructor(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceLeafHistory", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/internals/getWorkspaceLeafHistoryConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getWorkspaceLeafHistoryConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceMobileDrawerConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceMobileDrawer} constructor.\n *\n * @returns The {@link obsidian#WorkspaceMobileDrawer} constructor.\n *\n * @remark\n *\n * Constructor is `null`. See {@link https://forum.obsidian.md/t/api-bug-tasks-class/98993}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceMobileDrawerConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceMobileDrawer", "canonicalReference": "obsidian!WorkspaceMobileDrawer:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceMobileDrawerConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceMobileDrawerConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceParentConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceParent} constructor.\n *\n * @returns The {@link obsidian#WorkspaceParent} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceParentConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceParent", "canonicalReference": "obsidian!WorkspaceParent:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceParentConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceParentConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceRibbonConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceRibbon} constructor.\n *\n * @returns The {@link obsidian#WorkspaceRibbon} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceRibbonConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceRibbon", "canonicalReference": "obsidian!WorkspaceRibbon:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceRibbonConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceRibbonConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceRootConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceRoot} constructor.\n *\n * @returns The {@link obsidian#WorkspaceRoot} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceRootConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceRoot", "canonicalReference": "obsidian!WorkspaceRoot:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceRootConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceRootConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceSidedockConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceSidedock} constructor.\n *\n * @returns The {@link obsidian#WorkspaceSidedock} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceSidedockConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceSidedock", "canonicalReference": "obsidian!WorkspaceSidedock:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceSidedockConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceSidedockConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceSplitConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceSplit} constructor.\n *\n * @returns The {@link obsidian#WorkspaceSplit} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceSplitConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceSplit", "canonicalReference": "obsidian!WorkspaceSplit:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceSplitConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceSplitConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceTabsConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceTabs} constructor.\n *\n * @returns The {@link obsidian#WorkspaceTabs} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceTabsConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceTabs", "canonicalReference": "obsidian!WorkspaceTabs:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceTabsConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceTabsConstructor" }, { "kind": "Function", "canonicalReference": "obsidian-typings!getWorkspaceWindowConstructor:function(1)", "docComment": "/**\n * Get the {@link obsidian#WorkspaceWindow} constructor.\n *\n * @returns The {@link obsidian#WorkspaceWindow} constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getWorkspaceWindowConstructor(): " }, { "kind": "Reference", "text": "ExtractConstructor", "canonicalReference": "obsidian-typings!ExtractConstructor:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspaceWindow", "canonicalReference": "obsidian!WorkspaceWindow:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/constructors/augmentations/getWorkspaceWindowConstructor.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getWorkspaceWindowConstructor" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GlobalSearchPlugin:interface", "docComment": "/**\n * Internal plugin registration for the global search feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GlobalSearchPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GlobalSearchPluginInstance", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/global-search/GlobalSearchPlugin.d.ts", "releaseTag": "Public", "name": "GlobalSearchPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance:interface", "docComment": "/**\n * Plugin instance for global search, providing vault-wide text search functionality.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GlobalSearchPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GlobalSearchPlugin", "canonicalReference": "obsidian-typings!GlobalSearchPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/global-search/GlobalSearchPluginInstance.d.ts", "releaseTag": "Public", "name": "GlobalSearchPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#getGlobalSearchQuery:member(1)", "docComment": "/**\n * Gets the current global-search query string.\n *\n * @returns The current query, or an empty string when the search view is not open.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGlobalSearchQuery(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getGlobalSearchQuery" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#initLeaf:member(1)", "docComment": "/**\n * Ensures the global-search leaf exists in the left sidebar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initLeaf(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initLeaf" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#onEditorMenu:member(1)", "docComment": "/**\n * Adds a \"Search in selection\" item to the editor context menu.\n *\n * @param menu - The menu to add to.\n *\n * @param editor - The editor the menu was opened in.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEditorMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", editor: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onEditorMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Handles a settings change made externally (e.g. by Sync).\n *\n * @returns A promise that resolves when the change has been handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#onFileMenu:member(1)", "docComment": "/**\n * Adds a \"Search in folder\" item to the file context menu.\n *\n * @param menu - The menu to add to.\n *\n * @param file - The file or folder the menu was opened on.\n *\n * @param source - The source of the menu (e.g. `'file-explorer-context-menu'`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onFileMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#openGlobalSearch:member(1)", "docComment": "/**\n * Opens the global search with the given query.\n *\n * @param query - The search query.\n *\n * @param active - Whether to focus the search view. Defaults to `true`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openGlobalSearch(query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", active?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "active", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "openGlobalSearch" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#options:member", "docComment": "/**\n * The plugin's options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance#plugin:member", "docComment": "/**\n * Reference to the global search plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "GlobalSearchPlugin", "canonicalReference": "obsidian-typings!GlobalSearchPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!GlobalWorkerOptions:var", "docComment": "/**\n * Global worker options for PDF.js.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "GlobalWorkerOptions: " }, { "kind": "Reference", "text": "GlobalWorkerOptionsType", "canonicalReference": "obsidian-typings!GlobalWorkerOptionsType:interface" } ], "fileUrlPath": "src/pdfjs-dist/internals/vars/GlobalWorkerOptions.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "GlobalWorkerOptions", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GlobalWorkerOptionsType:interface", "docComment": "/**\n * Type for the global worker options object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GlobalWorkerOptionsType " } ], "fileUrlPath": "src/pdfjs-dist/internals/GlobalWorkerOptionsType.d.ts", "releaseTag": "Public", "name": "GlobalWorkerOptionsType", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GlobalWorkerOptionsType#workerPort:member", "docComment": "/**\n * The worker port.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workerPort: " }, { "kind": "Content", "text": "null | unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "workerPort", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GlobalWorkerOptionsType#workerSrc:member", "docComment": "/**\n * URL of the worker source file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workerSrc: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "workerSrc", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!Grammar:type", "docComment": "/**\n * A Prism grammar definition, combining common token names with arbitrary additional tokens.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Grammar = " }, { "kind": "Reference", "text": "GrammarRest", "canonicalReference": "obsidian-typings!GrammarRest:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/Grammar.d.ts", "releaseTag": "Public", "name": "Grammar", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GrammarRest:interface", "docComment": "/**\n * Common grammar token names with optional rest grammar reference.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GrammarRest " } ], "fileUrlPath": "src/prismjs/internals/GrammarRest.d.ts", "releaseTag": "Public", "name": "GrammarRest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#\"class-name\":member", "docComment": "/**\n * Class name grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'class-name'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "\"class-name\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#atrule:member", "docComment": "/**\n * ATRule grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'atrule'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "atrule", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#boolean:member", "docComment": "/**\n * Boolean grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'boolean'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "boolean", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#comment:member", "docComment": "/**\n * Comment grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'comment'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "comment", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#function:member", "docComment": "/**\n * Function grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'function'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "function", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#important:member", "docComment": "/**\n * Important grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'important'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "important", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#keyword:member", "docComment": "/**\n * Keyword grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'keyword'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "keyword", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#number:member", "docComment": "/**\n * Number grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'number'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "number", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#operator:member", "docComment": "/**\n * Operator grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'operator'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "operator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#property:member", "docComment": "/**\n * Property grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'property'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "property", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#punctuation:member", "docComment": "/**\n * Punctuation grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'punctuation'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "punctuation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#rest:member", "docComment": "/**\n * Nested rest grammar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'rest'?: " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#selector:member", "docComment": "/**\n * Selector grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'selector'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selector", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#string:member", "docComment": "/**\n * String grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'string'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "string", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#style:member", "docComment": "/**\n * Style grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'style'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "style", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GrammarRest#url:member", "docComment": "/**\n * URL grammar value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'url'?: " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!GrammarValue:type", "docComment": "/**\n * A grammar value: a single regex, a token object, or an array of either.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type GrammarValue = " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismTokenObject", "canonicalReference": "obsidian-typings!PrismTokenObject:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "PrismTokenObject", "canonicalReference": "obsidian-typings!PrismTokenObject:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/GrammarValue.d.ts", "releaseTag": "Public", "name": "GrammarValue", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphBookmarkItem:interface", "docComment": "/**\n * {@link Bookmark} item representing a saved graph view configuration.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphBookmarkItem extends " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/bookmark-items/GraphBookmarkItem.d.ts", "releaseTag": "Public", "name": "GraphBookmarkItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphBookmarkItem#options:member", "docComment": "/**\n * Graph view options saved with this bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "GraphPluginInstanceOptions", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphBookmarkItem#title:member", "docComment": "/**\n * Display title of this graph bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphBookmarkItem#type:member", "docComment": "/**\n * Discriminator indicating this is a graph bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'graph'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!GraphColor:type", "docComment": "/**\n * Available color types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type GraphColor =\n " }, { "kind": "Content", "text": "| 'arrow'\n | 'circle'\n | 'fill'\n | 'fillAttachment'\n | 'fillFocused'\n | 'fillHighlight'\n | 'fillTag'\n | 'fillUnresolved'\n | 'line'\n | 'lineHighlight'\n | 'text'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphColor.d.ts", "releaseTag": "Public", "name": "GraphColor", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphColorAttributes:interface", "docComment": "/**\n * Color attributes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphColorAttributes " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphColorAttributes.d.ts", "releaseTag": "Public", "name": "GraphColorAttributes", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphColorAttributes#a:member", "docComment": "/**\n * Alpha channel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "a: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "a", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphColorAttributes#rgb:member", "docComment": "/**\n * Color stored as an integer (`rgb = c.r << 16 | c.g << 8 | c.b` where channels are 8-bits unsigned integers).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rgb: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rgb", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphColorGroup:interface", "docComment": "/**\n * Group of nodes set by the user.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphColorGroup " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphColorGroup.d.ts", "releaseTag": "Public", "name": "GraphColorGroup", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphColorGroup#color:member", "docComment": "/**\n * Color associated to the group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Reference", "text": "GraphColorAttributes", "canonicalReference": "obsidian-typings!GraphColorAttributes:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphColorGroup#query:member", "docComment": "/**\n * Query associated to the group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphColorGroupOptions:interface", "docComment": "/**\n * Options section for managing color groups that visually categorize graph nodes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphColorGroupOptions extends " }, { "kind": "Reference", "text": "GraphOptions", "canonicalReference": "obsidian-typings!GraphOptions:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/options/GraphColorGroupOptions.d.ts", "releaseTag": "Public", "name": "GraphColorGroupOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphColorGroupOptions#groups:member", "docComment": "/**\n * List of UI groups, each representing a user-defined color group entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "groups: " }, { "kind": "Reference", "text": "GraphColorGroupOptionsGroup", "canonicalReference": "obsidian-typings!GraphColorGroupOptionsGroup:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "groups", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphColorGroupOptionsGroup:interface", "docComment": "/**\n * UI components for a single color group entry in the graph settings panel.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphColorGroupOptionsGroup " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/options/GraphColorGroupOptionsGroup.d.ts", "releaseTag": "Public", "name": "GraphColorGroupOptionsGroup", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphColorGroupOptionsGroup#color:member", "docComment": "/**\n * Color picker component for selecting the group color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Reference", "text": "ColorComponent", "canonicalReference": "obsidian!ColorComponent:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphColorGroupOptionsGroup#el:member", "docComment": "/**\n * Container element for this color group entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "el: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "el", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphColorGroupOptionsGroup#query:member", "docComment": "/**\n * Text input component for the search query that defines this group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Reference", "text": "TextComponent", "canonicalReference": "obsidian!TextComponent:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphData:interface", "docComment": "/**\n * Data selected to be rendered in the graph based on the current options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphData " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphData.d.ts", "releaseTag": "Public", "name": "GraphData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphData#nodes:member", "docComment": "/**\n * Record of nodes selected to be rendered. Their IDs are used as keys.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodes: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "GraphNodeData", "canonicalReference": "obsidian-typings!GraphNodeData:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphData#numLinks:member", "docComment": "/**\n * Number of links.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "numLinks: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numLinks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphDisplayOptions:interface", "docComment": "/**\n * Options section for graph display settings such as node size, line thickness, and arrows.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphDisplayOptions extends " }, { "kind": "Reference", "text": "GraphOptions", "canonicalReference": "obsidian-typings!GraphOptions:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/options/GraphDisplayOptions.d.ts", "releaseTag": "Public", "name": "GraphDisplayOptions", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphEngine:interface", "docComment": "/**\n * Engine of a graph view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphEngine " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphEngine.d.ts", "releaseTag": "Public", "name": "GraphEngine", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#app:member", "docComment": "/**\n * Reference to the Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#colorGroupOptions:member", "docComment": "/**\n * UI controls for configuring color group options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "colorGroupOptions: " }, { "kind": "Reference", "text": "GraphColorGroupOptions", "canonicalReference": "obsidian-typings!GraphColorGroupOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "colorGroupOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#controlsEl:member", "docComment": "/**\n * Container element for the graph settings controls panel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "controlsEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "controlsEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#currentFocusFile:member", "docComment": "/**\n * Path of the currently focused file in the local graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "currentFocusFile: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "currentFocusFile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#displayOptions:member", "docComment": "/**\n * UI controls for configuring display options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayOptions: " }, { "kind": "Reference", "text": "GraphDisplayOptions", "canonicalReference": "obsidian-typings!GraphDisplayOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "displayOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#fileFilter:member", "docComment": "/**\n * Filter determining which files are included in the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fileFilter: " }, { "kind": "Reference", "text": "GraphFileFilter", "canonicalReference": "obsidian-typings!GraphFileFilter:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fileFilter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#filterOptions:member", "docComment": "/**\n * UI controls for configuring filter options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filterOptions: " }, { "kind": "Reference", "text": "GraphFilterOptions", "canonicalReference": "obsidian-typings!GraphFilterOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filterOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#forceOptions:member", "docComment": "/**\n * UI controls for configuring force simulation options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forceOptions: " }, { "kind": "Reference", "text": "GraphForceOptions", "canonicalReference": "obsidian-typings!GraphForceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "forceOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphEngine#getOptions:member(1)", "docComment": "/**\n * Gets the engine options.\n *\n * @returns The current graph plugin instance options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOptions(): " }, { "kind": "Reference", "text": "GraphPluginInstanceOptions", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getOptions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#hasFilter:member", "docComment": "/**\n * Whether any search filter is currently active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasFilter: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hasFilter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#hoverPopover:member", "docComment": "/**\n * Hover popover displayed when hovering over a node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverPopover: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverPopover", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#lastHoverLink:member", "docComment": "/**\n * Last link that was hovered over.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastHoverLink: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastHoverLink", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#options:member", "docComment": "/**\n * Current graph plugin options applied to this engine.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "GraphPluginInstanceOptions", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#progression:member", "docComment": "/**\n * Current animation progression value for graph transitions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "progression: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "progression", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#progressionSpeed:member", "docComment": "/**\n * Speed of the animation progression.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "progressionSpeed: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "progressionSpeed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphEngine#render:member(1)", "docComment": "/**\n * Rerenders the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#renderer:member", "docComment": "/**\n * Renderer responsible for drawing the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderer: " }, { "kind": "Reference", "text": "GraphRenderer", "canonicalReference": "obsidian-typings!GraphRenderer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#searchQueries:member", "docComment": "/**\n * Active color group search queries for node coloring.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchQueries: " }, { "kind": "Reference", "text": "GraphColorGroup", "canonicalReference": "obsidian-typings!GraphColorGroup:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphEngine#setOptions:member(1)", "docComment": "/**\n * Sets the engine options.\n *\n * @param options - New options. Undefined elements will not be considered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOptions(options: " }, { "kind": "Reference", "text": "GraphPluginInstanceOptions", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "setOptions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphEngine#updateSearch:member(1)", "docComment": "/**\n * Updates the engine after the search filter has changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateSearch" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphEngine#view:member", "docComment": "/**\n * The view (local or global) that owns this engine.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "view: " }, { "kind": "Reference", "text": "GraphView", "canonicalReference": "obsidian-typings!GraphView:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "LocalGraphView", "canonicalReference": "obsidian-typings!LocalGraphView:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphFileFilter:interface", "docComment": "/**\n * Filter map determining which files appear in the graph, keyed by file path with color or visibility values.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphFileFilter extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, boolean | " }, { "kind": "Reference", "text": "GraphColorAttributes", "canonicalReference": "obsidian-typings!GraphColorAttributes:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphFileFilter.d.ts", "releaseTag": "Public", "name": "GraphFileFilter", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphFilterOptions:interface", "docComment": "/**\n * Options section for graph filter settings controlling which files appear in the graph.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphFilterOptions extends " }, { "kind": "Reference", "text": "GraphOptions", "canonicalReference": "obsidian-typings!GraphOptions:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/options/GraphFilterOptions.d.ts", "releaseTag": "Public", "name": "GraphFilterOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphFilterOptions#search:member", "docComment": "/**\n * Search input component for filtering graph nodes by query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "search: " }, { "kind": "Reference", "text": "SearchComponent", "canonicalReference": "obsidian!SearchComponent:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "search", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphFilterOptions#searchSetting:member", "docComment": "/**\n * {@link obsidian#Setting} element containing the search input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchSetting: " }, { "kind": "Reference", "text": "Setting", "canonicalReference": "obsidian!Setting:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchSetting", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphForceOptions:interface", "docComment": "/**\n * Options section for graph force simulation parameters such as repel, link, and center forces.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphForceOptions extends " }, { "kind": "Reference", "text": "GraphOptions", "canonicalReference": "obsidian-typings!GraphOptions:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/options/GraphForceOptions.d.ts", "releaseTag": "Public", "name": "GraphForceOptions", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphForces:interface", "docComment": "/**\n * Graph forces.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphForces " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphForces.d.ts", "releaseTag": "Public", "name": "GraphForces", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphForces#centerStrength:member", "docComment": "/**\n * Strength of the force pulling nodes toward the center of the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "centerStrength?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "centerStrength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphForces#linkDistance:member", "docComment": "/**\n * Ideal distance between linked nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linkDistance?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "linkDistance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphForces#linkStrength:member", "docComment": "/**\n * Strength of the attractive force between linked nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linkStrength?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "linkStrength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphForces#repelStrength:member", "docComment": "/**\n * Strength of the repulsive force pushing nodes apart.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "repelStrength?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "repelStrength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!Graphics:class", "docComment": "/**\n * Graphics class for drawing shapes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Graphics extends " }, { "kind": "Reference", "text": "Container", "canonicalReference": "obsidian-typings!Container:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/pixi.js/internals/Graphics.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Graphics", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!Graphics:constructor(1)", "docComment": "/**\n * Creates a new graphics object.\n *\n * @param geometry - The geometry to use.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(geometry?: " }, { "kind": "Reference", "text": "GraphicsGeometry", "canonicalReference": "obsidian-typings!GraphicsGeometry:class" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "geometry", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#arc:member(1)", "docComment": "/**\n * Draws an arc.\n *\n * @param cx - Center X.\n *\n * @param cy - Center Y.\n *\n * @param radius - Arc radius.\n *\n * @param startAngle - Start angle in radians.\n *\n * @param endAngle - End angle in radians.\n *\n * @param anticlockwise - Whether to draw anticlockwise.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "arc(cx: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", cy: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", radius: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", startAngle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", endAngle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", anticlockwise?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "cx", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "cy", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "radius", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "startAngle", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "endAngle", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "anticlockwise", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "arc" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#arcTo:member(1)", "docComment": "/**\n * Draws an arc between two tangent lines.\n *\n * @param x1 - First point X.\n *\n * @param y1 - First point Y.\n *\n * @param x2 - Second point X.\n *\n * @param y2 - Second point Y.\n *\n * @param radius - Arc radius.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "arcTo(x1: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y1: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", x2: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y2: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", radius: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y1", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "x2", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "y2", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "radius", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "arcTo" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#beginFill:member(1)", "docComment": "/**\n * Begins filling a shape with color.\n *\n * @param color - Fill color.\n *\n * @param alpha - Fill alpha.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "beginFill(color?: " }, { "kind": "Reference", "text": "ColorSource", "canonicalReference": "obsidian-typings!ColorSource:type" }, { "kind": "Content", "text": ", alpha?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "alpha", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "beginFill" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#bezierCurveTo:member(1)", "docComment": "/**\n * Draws a cubic bezier curve.\n *\n * @param cpX - First control point X.\n *\n * @param cpY - First control point Y.\n *\n * @param cpX2 - Second control point X.\n *\n * @param cpY2 - Second control point Y.\n *\n * @param toX - End point X.\n *\n * @param toY - End point Y.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bezierCurveTo(cpX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", cpY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", cpX2: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", cpY2: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", toX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", toY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "cpX", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "cpY", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "cpX2", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "cpY2", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "toX", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "toY", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "bezierCurveTo" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#clear:member(1)", "docComment": "/**\n * Clears all drawn graphics.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "clear" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#clone:member(1)", "docComment": "/**\n * Clones this graphics object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clone(): " }, { "kind": "Reference", "text": "Graphics", "canonicalReference": "obsidian-typings!Graphics:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "clone" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#closePath:member(1)", "docComment": "/**\n * Closes the current path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closePath(): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "closePath" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#destroy:member(1)", "docComment": "/**\n * Destroys this graphics object.\n *\n * @param options - Destroy options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(options?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "IDestroyOptions", "canonicalReference": "obsidian-typings!IDestroyOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#drawCircle:member(1)", "docComment": "/**\n * Draws a circle.\n *\n * @param x - Center X.\n *\n * @param y - Center Y.\n *\n * @param radius - Circle radius.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "drawCircle(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", radius: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "radius", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "drawCircle" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#drawEllipse:member(1)", "docComment": "/**\n * Draws an ellipse.\n *\n * @param x - Center X.\n *\n * @param y - Center Y.\n *\n * @param width - Half width.\n *\n * @param height - Half height.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "drawEllipse(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "drawEllipse" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#drawRect:member(1)", "docComment": "/**\n * Draws a rectangle.\n *\n * @param x - X position.\n *\n * @param y - Y position.\n *\n * @param width - Width.\n *\n * @param height - Height.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "drawRect(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "drawRect" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#drawRoundedRect:member(1)", "docComment": "/**\n * Draws a rounded rectangle.\n *\n * @param x - X position.\n *\n * @param y - Y position.\n *\n * @param width - Width.\n *\n * @param height - Height.\n *\n * @param radius - Corner radius.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "drawRoundedRect(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", radius: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "radius", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "drawRoundedRect" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#endFill:member(1)", "docComment": "/**\n * Ends filling a shape.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "endFill(): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "endFill" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#lineStyle:member(1)", "docComment": "/**\n * Sets the line style.\n *\n * @param width - Line width.\n *\n * @param color - Line color.\n *\n * @param alpha - Line alpha.\n *\n * @param alignment - Line alignment.\n *\n * @param native - Whether to use native line drawing.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineStyle(width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", color?: " }, { "kind": "Reference", "text": "ColorSource", "canonicalReference": "obsidian-typings!ColorSource:type" }, { "kind": "Content", "text": ", alpha?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", alignment?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", native?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "alpha", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "alignment", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "native", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "lineStyle" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#lineTo:member(1)", "docComment": "/**\n * Draws a line to a point.\n *\n * @param x - X coordinate.\n *\n * @param y - Y coordinate.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineTo(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "lineTo" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#moveTo:member(1)", "docComment": "/**\n * Moves the drawing cursor to a point.\n *\n * @param x - X coordinate.\n *\n * @param y - Y coordinate.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveTo(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "moveTo" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Graphics#quadraticCurveTo:member(1)", "docComment": "/**\n * Draws a quadratic bezier curve.\n *\n * @param cpX - Control point X.\n *\n * @param cpY - Control point Y.\n *\n * @param toX - End point X.\n *\n * @param toY - End point Y.\n *\n * @returns This graphics for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "quadraticCurveTo(cpX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", cpY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", toX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", toY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "cpX", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "cpY", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "toX", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "toY", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "quadraticCurveTo" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Graphics#tint:member", "docComment": "/**\n * Tint color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get tint(): " }, { "kind": "Reference", "text": "ColorSource", "canonicalReference": "obsidian-typings!ColorSource:type" }, { "kind": "Content", "text": ";\n\nset tint(value: " }, { "kind": "Reference", "text": "ColorSource", "canonicalReference": "obsidian-typings!ColorSource:type" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!GraphicsGeometry:class", "docComment": "/**\n * Graphics geometry.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class GraphicsGeometry " } ], "fileUrlPath": "src/pixi.js/internals/GraphicsGeometry.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "GraphicsGeometry", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!GraphicsGeometry:constructor(1)", "docComment": "/**\n * Create new instance of {@link GraphicsGeometry}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor();" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [] } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphLink:interface", "docComment": "/**\n * Represents a link in a graph view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphLink " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphLink.d.ts", "releaseTag": "Public", "name": "GraphLink", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphLink#arrow:member", "docComment": "/**\n * PixiJS element for the arrow, child of {@link GraphRenderer.hanger}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "arrow: " }, { "kind": "Reference", "text": "Graphics", "canonicalReference": "obsidian-typings!Graphics:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "arrow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphLink#clearGraphics:member(1)", "docComment": "/**\n * Destroy the graphics and its children, and remove them from the scene.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearGraphics(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearGraphics" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphLink#initGraphics:member(1)", "docComment": "/**\n * Initialize the link (line and arrow), and add them to the scene.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initGraphics(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initGraphics" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphLink#line:member", "docComment": "/**\n * PixiJS element for the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "line: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Sprite", "canonicalReference": "obsidian-typings!Sprite:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "line", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphLink#px:member", "docComment": "/**\n * Parent of {@link GraphLink.line}, child of {@link GraphRenderer.hanger}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "px: " }, { "kind": "Reference", "text": "Container", "canonicalReference": "obsidian-typings!Container:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "px", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphLink#render:member(1)", "docComment": "/**\n * Render the link.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphLink#rendered:member", "docComment": "/**\n * Whether the link graphics have been rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rendered: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rendered", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphLink#renderer:member", "docComment": "/**\n * {@link GraphRenderer} managing this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderer: " }, { "kind": "Reference", "text": "GraphRenderer", "canonicalReference": "obsidian-typings!GraphRenderer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphLink#source:member", "docComment": "/**\n * Source node of the link.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "source: " }, { "kind": "Reference", "text": "GraphNode", "canonicalReference": "obsidian-typings!GraphNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphLink#target:member", "docComment": "/**\n * Target node of the link.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "target: " }, { "kind": "Reference", "text": "GraphNode", "canonicalReference": "obsidian-typings!GraphNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "target", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphNode:interface", "docComment": "/**\n * Represents a node in the graph view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphNode " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphNode.d.ts", "releaseTag": "Public", "name": "GraphNode", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#circle:member", "docComment": "/**\n * PixiJS element for the circle, child of {@link GraphRenderer.hanger}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "circle: " }, { "kind": "Reference", "text": "Graphics", "canonicalReference": "obsidian-typings!Graphics:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "circle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#clearGraphics:member(1)", "docComment": "/**\n * Destroy the graphics and its children, and remove them from the scene.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearGraphics(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearGraphics" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#color:member", "docComment": "/**\n * Computed color for the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Reference", "text": "GraphColorAttributes", "canonicalReference": "obsidian-typings!GraphColorAttributes:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#fadeAlpha:member", "docComment": "/**\n * Current fade alpha value controlling the node's transparency during transitions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fadeAlpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fadeAlpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#fontDirty:member", "docComment": "/**\n * Indicates if the text needs to be re-rendered when the node is rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontDirty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontDirty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#forward:member", "docComment": "/**\n * Record of forward links. Keys are the id of the neighbor nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forward: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "GraphLink", "canonicalReference": "obsidian-typings!GraphLink:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "forward", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#fx:member", "docComment": "/**\n * Forced x position when the node is dragged.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fx: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#fy:member", "docComment": "/**\n * Forced y position when the node is dragged.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fy: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#getDisplayText:member(1)", "docComment": "/**\n * Get the displayed text associated to the node.\n *\n * @returns The displayed text of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDisplayText(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDisplayText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#getFillColor:member(1)", "docComment": "/**\n * Get the current fill color.\n *\n * @returns The color of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFillColor(): " }, { "kind": "Reference", "text": "GraphColorAttributes", "canonicalReference": "obsidian-typings!GraphColorAttributes:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFillColor" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#getRelated:member(1)", "docComment": "/**\n * Get the ids of connected nodes (back and forward links).\n *\n * @returns An array of string ids of connected nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRelated(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getRelated" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#getSize:member(1)", "docComment": "/**\n * Get the current size of the node, after weight and node size multiplier have been applied.\n *\n * @returns The size of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSize(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#getTextStyle:member(1)", "docComment": "/**\n * Get the text style of the node.\n *\n * @returns The text style of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTextStyle(): " }, { "kind": "Reference", "text": "TextStyle", "canonicalReference": "obsidian-typings!TextStyle:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTextStyle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#highlight:member", "docComment": "/**\n * Colored circle added if the node is highlighted, child of {@link GraphNode.circle}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlight: " }, { "kind": "Reference", "text": "Graphics", "canonicalReference": "obsidian-typings!Graphics:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "highlight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#id:member", "docComment": "/**\n * ID of the node (path, tag, or name for non-existing files).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#initGraphics:member(1)", "docComment": "/**\n * Initialize the node, text, listeners, and add them to the scene.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initGraphics(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initGraphics" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#moveText:member", "docComment": "/**\n * Displacement of the text, changed when the node is hovered\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveText: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "moveText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#onClick:member(1)", "docComment": "/**\n * Method called when the node (circle) is clicked, trigger the context menu if it's a right click\n *\n * @param e - The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onClick(e: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphNode#render:member(1)", "docComment": "/**\n * Render the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#rendered:member", "docComment": "/**\n * Whether the node graphics have been rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rendered: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rendered", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#renderer:member", "docComment": "/**\n * {@link GraphRenderer} managing this node\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderer: " }, { "kind": "Reference", "text": "GraphRenderer", "canonicalReference": "obsidian-typings!GraphRenderer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#reverse:member", "docComment": "/**\n * Record of backward links. Keys are the id of the neighbor nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reverse: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "GraphLink", "canonicalReference": "obsidian-typings!GraphLink:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "reverse", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#text:member", "docComment": "/**\n * PixiJS element for the name, child of {@link GraphNode.circle}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "PIXIText", "canonicalReference": "obsidian-typings!PixiText:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#type:member", "docComment": "/**\n * Type of the node, can be of value `\"tag\"`, `\"unresolved\"`, `\"attachment\"`, or an empty string for markdown nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#weight:member", "docComment": "/**\n * Weight of the node depending on the number of related nodes (forwards and backward).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "weight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "weight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#x:member", "docComment": "/**\n * X-axis position of the node in the graph\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNode#y:member", "docComment": "/**\n * Y-axis position of the node in the graph\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphNodeData:interface", "docComment": "/**\n * Node data, used before the rendering process.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphNodeData " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphNodeData.d.ts", "releaseTag": "Public", "name": "GraphNodeData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNodeData#color:member", "docComment": "/**\n * Color of the node if it is part of a group\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color?: " }, { "kind": "Reference", "text": "GraphColorAttributes", "canonicalReference": "obsidian-typings!GraphColorAttributes:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNodeData#links:member", "docComment": "/**\n * Record of forward neighbor nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "links: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, boolean>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "links", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphNodeData#type:member", "docComment": "/**\n * Type of the node, can be of value `\"tag\"`, `\"unresolved\"`, `\"attachment\"`, or an empty string for markdown nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphOptions:interface", "docComment": "/**\n * Base interface for a collapsible graph options section in the settings panel.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphOptions extends " }, { "kind": "Reference", "text": "TreeCollapsibleItem", "canonicalReference": "obsidian-typings!TreeCollapsibleItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/options/GraphOptions.d.ts", "releaseTag": "Public", "name": "GraphOptions", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphOptions#getOptions:member(1)", "docComment": "/**\n * Get the current values of this options section.\n *\n * @param e - The options context.\n *\n * @returns The current option values.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOptions(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getOptions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphOptions#setOptions:member(1)", "docComment": "/**\n * Apply new values to this options section.\n *\n * @param e - The options to apply.\n *\n * @returns The applied option values.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOptions(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setOptions" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphPlugin:interface", "docComment": "/**\n * Internal plugin that provides graph view functionality.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GraphPluginInstance", "canonicalReference": "obsidian-typings!GraphPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphPlugin.d.ts", "releaseTag": "Public", "name": "GraphPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphPluginInstance:interface", "docComment": "/**\n * Instance of the graph internal plugin, managing graph views and options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GraphPlugin", "canonicalReference": "obsidian-typings!GraphPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphPluginInstance.d.ts", "releaseTag": "Public", "name": "GraphPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#app:member", "docComment": "/**\n * Reference to the Obsidian app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#defaultOn:member", "docComment": "/**\n * Whether the graph plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Reload options when settings are changed externally.\n *\n * @returns A promise that resolves when the settings are reloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#onFileMenu:member(1)", "docComment": "/**\n * Add graph-related items to the file context menu.\n *\n * @param menu - The context menu to add items to.\n *\n * @param file - The file associated with the menu.\n *\n * @param source - The source of the menu event.\n *\n * @param leaf - The workspace leaf, if available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", leaf?: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "onFileMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#openGraphView:member(1)", "docComment": "/**\n * Open the global graph view.\n *\n * @param newLeaf - Whether to open the graph in a new leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openGraphView(newLeaf: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "newLeaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "openGraphView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#openLocalGraph:member(1)", "docComment": "/**\n * Open the local graph view for the current file.\n *\n * @param checking - Whether to only check if the command can be executed.\n *\n * @returns `true` if the command can be executed, or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openLocalGraph(checking: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "true | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "checking", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "openLocalGraph" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#options:member", "docComment": "/**\n * User-configurable options for the graph plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "GraphPluginInstanceOptions", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#plugin:member", "docComment": "/**\n * Reference to the parent graph plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "GraphPlugin", "canonicalReference": "obsidian-typings!GraphPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphPluginInstance#saveOptions:member(1)", "docComment": "/**\n * Saves the options in graph.json.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveOptions(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveOptions" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions:interface", "docComment": "/**\n * User-configurable options for the graph plugin, persisted in graph.json.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphPluginInstanceOptions " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphPluginInstanceOptions.d.ts", "releaseTag": "Public", "name": "GraphPluginInstanceOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#\"collapse-color-groups\":member", "docComment": "/**\n * Whether the color groups section is collapsed in the settings panel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'collapse-color-groups'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "\"collapse-color-groups\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#\"collapse-display\":member", "docComment": "/**\n * Whether the display section is collapsed in the settings panel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'collapse-display'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "\"collapse-display\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#\"collapse-filter\":member", "docComment": "/**\n * Whether the filter section is collapsed in the settings panel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'collapse-filter'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "\"collapse-filter\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#\"collapse-forces\":member", "docComment": "/**\n * Whether the forces section is collapsed in the settings panel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'collapse-forces'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "\"collapse-forces\"", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#centerStrength:member", "docComment": "/**\n * Strength of the centering force pulling nodes toward the graph center.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'centerStrength'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "centerStrength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#close:member", "docComment": "/**\n * Whether the graph settings panel is closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'close'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "close", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#colorGroups:member", "docComment": "/**\n * User-defined color groups for visually grouping nodes by search query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'colorGroups'?: " }, { "kind": "Reference", "text": "GraphColorGroup", "canonicalReference": "obsidian-typings!GraphColorGroup:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "colorGroups", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#hideUnresolved:member", "docComment": "/**\n * Whether to hide unresolved (non-existing) linked notes from the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'hideUnresolved'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hideUnresolved", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#lineSizeMultiplier:member", "docComment": "/**\n * Multiplier for the thickness of link lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'lineSizeMultiplier'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lineSizeMultiplier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#linkDistance:member", "docComment": "/**\n * Ideal distance between linked nodes in the force simulation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'linkDistance'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "linkDistance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#linkStrength:member", "docComment": "/**\n * Strength of the attractive force between linked nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'linkStrength'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "linkStrength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#localBacklinks:member", "docComment": "/**\n * Whether to show backlinks in the local graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'localBacklinks'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "localBacklinks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#localForelinks:member", "docComment": "/**\n * Whether to show forward links in the local graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'localForelinks'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "localForelinks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#localInterlinks:member", "docComment": "/**\n * Whether to show links between neighbor nodes in the local graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'localInterlinks'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "localInterlinks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#localJumps:member", "docComment": "/**\n * Number of link hops to traverse from the current note in the local graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'localJumps'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "localJumps", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#nodeSizeMultiplier:member", "docComment": "/**\n * Multiplier for the size of nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'nodeSizeMultiplier'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nodeSizeMultiplier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#repelStrength:member", "docComment": "/**\n * Strength of the repulsive force pushing nodes apart.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'repelStrength'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "repelStrength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#scale:member", "docComment": "/**\n * Zoom scale level of the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'scale'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#search:member", "docComment": "/**\n * Search query used to filter which files appear in the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'search'?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "search", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#showArrow:member", "docComment": "/**\n * Whether to display directional arrows on links.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'showArrow'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showArrow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#showAttachments:member", "docComment": "/**\n * Whether to display attachment files in the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'showAttachments'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showAttachments", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#showOrphans:member", "docComment": "/**\n * Whether to display orphan notes (notes with no links) in the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'showOrphans'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showOrphans", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#showTags:member", "docComment": "/**\n * Whether to display tags as nodes in the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'showTags'?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showTags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions#textFadeMultiplier:member", "docComment": "/**\n * Multiplier controlling the distance at which node labels begin to fade.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "'textFadeMultiplier'?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "textFadeMultiplier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphRenderer:interface", "docComment": "/**\n * Renderer for the graph view, managing PixiJS rendering, user interactions, and layout.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphRenderer " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphRenderer.d.ts", "releaseTag": "Public", "name": "GraphRenderer", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#changed:member(1)", "docComment": "/**\n * Specify that the renderer has changed and needs to be rendered again.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changed(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "changed" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#colors:member", "docComment": "/**\n * General colors of the elements in the graph view, computed from the app CSS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "colors: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "GraphColor", "canonicalReference": "obsidian-typings!GraphColor:type" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "GraphColorAttributes", "canonicalReference": "obsidian-typings!GraphColorAttributes:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "colors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#containerEl:member", "docComment": "/**\n * `<div>` element containing the graph, with class `.view-content`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#destroy:member(1)", "docComment": "/**\n * Destroy the renderer and release all resources.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#destroyGraphics:member(1)", "docComment": "/**\n * Destroy all the graphics of the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroyGraphics(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroyGraphics" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#dragNode:member", "docComment": "/**\n * Node currently being dragged, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragNode: " }, { "kind": "Reference", "text": "GraphNode", "canonicalReference": "obsidian-typings!GraphNode:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dragNode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#fLineSizeMult:member", "docComment": "/**\n * Factor for the thickness of the links.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fLineSizeMult: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fLineSizeMult", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#fNodeSizeMult:member", "docComment": "/**\n * Factor for the size of the nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fNodeSizeMult: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fNodeSizeMult", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#fShowArrow:member", "docComment": "/**\n * Indicates if arrows should be displayed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fShowArrow: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fShowArrow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#fTextShowMult:member", "docComment": "/**\n * Text fade threshold.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fTextShowMult: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fTextShowMult", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#getBackgroundScreenshot:member(1)", "docComment": "/**\n * Capture a screenshot of the graph with the background included.\n *\n * @returns The canvas element containing the screenshot.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBackgroundScreenshot(): " }, { "kind": "Reference", "text": "HTMLCanvasElement", "canonicalReference": "!HTMLCanvasElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getBackgroundScreenshot" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#getHighlightNode:member(1)", "docComment": "/**\n * Returns the currently highlighted node, if any.\n *\n * @returns The highlighted node, or `null` if none.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHighlightNode(): " }, { "kind": "Reference", "text": "GraphNode", "canonicalReference": "obsidian-typings!GraphNode:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getHighlightNode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#getTransparentScreenshot:member(1)", "docComment": "/**\n * Capture a screenshot of the graph with a transparent background.\n *\n * @returns The canvas containing the screenshot.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTransparentScreenshot(): " }, { "kind": "Reference", "text": "ICanvas", "canonicalReference": "obsidian-typings!ICanvas:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTransparentScreenshot" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#hanger:member", "docComment": "/**\n * Main container to which nodes, links and arrows are added.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hanger: " }, { "kind": "Reference", "text": "Container", "canonicalReference": "obsidian-typings!Container:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hanger", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#height:member", "docComment": "/**\n * Height of the graph view, in pixel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#hidePowerTag:member", "docComment": "/**\n * Whether to hide the power tag indicator in the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hidePowerTag: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hidePowerTag", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#highlightNode:member", "docComment": "/**\n * Node currently being highlighted, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlightNode: " }, { "kind": "Reference", "text": "GraphNode", "canonicalReference": "obsidian-typings!GraphNode:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "highlightNode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#idleFrames:member", "docComment": "/**\n * Number of idle frames. The simulation stops running at 60.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "idleFrames: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "idleFrames", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#iframeEl:member", "docComment": "/**\n * `<iframe>` element in which the graph is rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iframeEl: " }, { "kind": "Reference", "text": "HTMLIFrameElement", "canonicalReference": "!HTMLIFrameElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "iframeEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#initGraphics:member(1)", "docComment": "/**\n * Initialize all the graphics of the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initGraphics(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initGraphics" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#interactiveEl:member", "docComment": "/**\n * `<canvas>` element bound to the event system of {@link GraphRenderer.px} to capture events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interactiveEl: " }, { "kind": "Reference", "text": "HTMLCanvasElement", "canonicalReference": "!HTMLCanvasElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "interactiveEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#keyboardActions:member", "docComment": "/**\n * Keyboard action bindings for graph interaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyboardActions: " }, { "kind": "Reference", "text": "KeyboardActions", "canonicalReference": "obsidian-typings!KeyboardActions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyboardActions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#links:member", "docComment": "/**\n * List of links currently rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "links: " }, { "kind": "Reference", "text": "GraphLink", "canonicalReference": "obsidian-typings!GraphLink:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "links", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#mouseX:member", "docComment": "/**\n * Mouse x coordinate in the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mouseX: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mouseX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#mouseY:member", "docComment": "/**\n * Mouse y coordinate in the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mouseY: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mouseY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#nodeLookup:member", "docComment": "/**\n * Record of the nodes currently rendered, with {@link GraphNode.id} used as key.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeLookup: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "GraphNode", "canonicalReference": "obsidian-typings!GraphNode:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodeLookup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#nodes:member", "docComment": "/**\n * List of nodes currently rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodes: " }, { "kind": "Reference", "text": "GraphNode", "canonicalReference": "obsidian-typings!GraphNode:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#nodeScale:member", "docComment": "/**\n * Scale of the nodes based on the zoom level of the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeScale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nodeScale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onIframeLoad:member(1)", "docComment": "/**\n * Called when the graph iframe finishes loading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onIframeLoad(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onIframeLoad" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onIframeUnload:member(1)", "docComment": "/**\n * Called when the graph iframe is unloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onIframeUnload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onIframeUnload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onMouseMove:member(1)", "docComment": "/**\n * Handle mouse movement over the graph view.\n *\n * @param evt - The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMouseMove(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onMouseMove" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onNodeClick:member(1)", "docComment": "/**\n * Handle a click on a graph node.\n *\n * @param evt - The mouse event.\n *\n * @param id - The identifier of the clicked node.\n *\n * @param type - The type of the clicked node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onNodeClick(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onNodeClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onNodeHover:member(1)", "docComment": "/**\n * Handle hover over a graph node.\n *\n * @param evt - The mouse event.\n *\n * @param id - The identifier of the hovered node.\n *\n * @param type - The type of the hovered node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onNodeHover(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onNodeHover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onNodeRightClick:member(1)", "docComment": "/**\n * Handle a right-click on a graph node.\n *\n * @param evt - The mouse event.\n *\n * @param id - The identifier of the right-clicked node.\n *\n * @param type - The type of the right-clicked node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onNodeRightClick(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onNodeRightClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onNodeUnhover:member(1)", "docComment": "/**\n * Handle the pointer leaving a graph node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onNodeUnhover(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onNodeUnhover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onPointerDown:member(1)", "docComment": "/**\n * Handle a pointer down event on the graph.\n *\n * @param renderer - The graph renderer instance.\n *\n * @param evt - The pointer event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPointerDown(renderer: " }, { "kind": "Reference", "text": "GraphRenderer", "canonicalReference": "obsidian-typings!GraphRenderer:interface" }, { "kind": "Content", "text": ", evt: " }, { "kind": "Reference", "text": "PointerEvent", "canonicalReference": "!PointerEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "renderer", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onPointerDown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onPointerOut:member(1)", "docComment": "/**\n * Handle the pointer leaving the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPointerOut(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onPointerOut" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onPointerOver:member(1)", "docComment": "/**\n * Handle the pointer entering the graph view.\n *\n * @param renderer - The graph renderer instance.\n *\n * @param evt - The pointer event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPointerOver(renderer: " }, { "kind": "Reference", "text": "GraphRenderer", "canonicalReference": "obsidian-typings!GraphRenderer:interface" }, { "kind": "Content", "text": ", evt: " }, { "kind": "Reference", "text": "PointerEvent", "canonicalReference": "!PointerEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "renderer", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onPointerOver" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onResize:member(1)", "docComment": "/**\n * Handle a resize of the graph container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#onWheel:member(1)", "docComment": "/**\n * Handle a wheel (scroll/zoom) event on the graph view.\n *\n * @param evt - The wheel event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onWheel(evt: " }, { "kind": "Reference", "text": "WheelEvent", "canonicalReference": "!WheelEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onWheel" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#panning:member", "docComment": "/**\n * Whether the user is currently panning the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "panning: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "panning", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#panvX:member", "docComment": "/**\n * Current pan velocity along the x axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "panvX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "panvX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#panvY:member", "docComment": "/**\n * Current pan velocity along the y axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "panvY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "panvY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#panX:member", "docComment": "/**\n * Current pan offset along the x axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "panX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "panX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#panY:member", "docComment": "/**\n * Current pan offset along the y axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "panY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "panY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#powerTag:member", "docComment": "/**\n * Power tag configuration for the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "powerTag: " }, { "kind": "Reference", "text": "PowerTag", "canonicalReference": "obsidian-typings!PowerTag:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "powerTag", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#px:member", "docComment": "/**\n * PixiJS application rendering everything.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "px: " }, { "kind": "Reference", "text": "Application", "canonicalReference": "obsidian-typings!Application:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "px", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#queueRender:member(1)", "docComment": "/**\n * Queue a render frame to be executed on the next animation frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queueRender(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "queueRender" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#renderCallback:member(1)", "docComment": "/**\n * Callback invoked on each render frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderCallback(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "renderCallback" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#renderTimer:member", "docComment": "/**\n * Timer (request ID) associated to the requestAnimationFrame rendering the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderTimer: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderTimer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#resetPan:member(1)", "docComment": "/**\n * Reset the pan offset to the origin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resetPan(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "resetPan" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#scale:member", "docComment": "/**\n * Current zoom level of the graph view, interpolated between the previous one and the {@link GraphRenderer.targetScale}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#setData:member(1)", "docComment": "/**\n * Set the graph data (nodes and links) to render.\n *\n * @param data - The graph data containing nodes and links.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setData(data: " }, { "kind": "Reference", "text": "GraphData", "canonicalReference": "obsidian-typings!GraphData:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#setForces:member(1)", "docComment": "/**\n * Set the force simulation parameters.\n *\n * @param forces - The force simulation parameters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setForces(forces: " }, { "kind": "Reference", "text": "GraphForces", "canonicalReference": "obsidian-typings!GraphForces:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "forces", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setForces" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#setPan:member(1)", "docComment": "/**\n * Set the pan offset to the given coordinates.\n *\n * @param panX - The pan offset along the x axis.\n *\n * @param panY - The pan offset along the y axis.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPan(panX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", panY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "panX", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "panY", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setPan" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#setRenderOptions:member(1)", "docComment": "/**\n * Set the rendering options for the graph view.\n *\n * @param options - The graph plugin instance options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setRenderOptions(options: " }, { "kind": "Reference", "text": "GraphPluginInstanceOptions", "canonicalReference": "obsidian-typings!GraphPluginInstanceOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setRenderOptions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#setScale:member(1)", "docComment": "/**\n * Set the zoom scale of the graph view.\n *\n * @param scale - The zoom scale level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setScale(scale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scale", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setScale" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#targetScale:member", "docComment": "/**\n * Target zoom level of the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "targetScale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "targetScale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#testCSS:member(1)", "docComment": "/**\n * Re-read CSS variables and update the graph colors accordingly.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testCSS(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "testCSS" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#textAlpha:member", "docComment": "/**\n * Current alpha of the nodes names based on the graph scale.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textAlpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "textAlpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#updateZoom:member(1)", "docComment": "/**\n * Interpolate the current zoom level towards the target scale.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateZoom(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateZoom" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#viewport:member", "docComment": "/**\n * Current visible viewport bounds of the graph view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewport: " }, { "kind": "Reference", "text": "Coords", "canonicalReference": "obsidian-typings!Coords:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#width:member", "docComment": "/**\n * Width of the graph view, in pixel.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#worker:member", "docComment": "/**\n * Web Worker thread running the graph simulation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "worker: " }, { "kind": "Reference", "text": "Worker", "canonicalReference": "!Worker:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "worker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#workerResults:member", "docComment": "/**\n * Results received from the graph simulation worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workerResults: " }, { "kind": "Reference", "text": "WorkerResults", "canonicalReference": "obsidian-typings!WorkerResults:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "workerResults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#zoomCenterX:member", "docComment": "/**\n * X coordinate of the zoom action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomCenterX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zoomCenterX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphRenderer#zoomCenterY:member", "docComment": "/**\n * Y coordinate of the zoom action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomCenterY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "zoomCenterY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphRenderer#zoomTo:member(1)", "docComment": "/**\n * Zoom the graph view to the given scale, centered on the given point.\n *\n * @param scale - The target zoom scale.\n *\n * @param pointer - The point to center the zoom on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomTo(scale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", pointer: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "obsidian!Point:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scale", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "pointer", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "zoomTo" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GraphView:interface", "docComment": "/**\n * Obsidian view for a global graph.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GraphView extends " }, { "kind": "Reference", "text": "ItemView", "canonicalReference": "obsidian!ItemView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/GraphView.d.ts", "releaseTag": "Public", "name": "GraphView", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphView#dataEngine:member", "docComment": "/**\n * Graph engine powering the global graph simulation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dataEngine: " }, { "kind": "Reference", "text": "GraphEngine", "canonicalReference": "obsidian-typings!GraphEngine:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dataEngine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The graph view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Graph", "canonicalReference": "obsidian-typings!~__type#Graph:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphView#onOptionsChange:member(1)", "docComment": "/**\n * Updates the options from the plugin when changed in view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onOptionsChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onOptionsChange" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GraphView#renderer:member", "docComment": "/**\n * Renderer responsible for drawing the global graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderer: " }, { "kind": "Reference", "text": "GraphRenderer", "canonicalReference": "obsidian-typings!GraphRenderer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!GraphView#update:member(1)", "docComment": "/**\n * Renders the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GreaterFunction:interface", "docComment": "/**\n * Function `Greater`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GreaterFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/GreaterFunction.d.ts", "releaseTag": "Public", "name": "GreaterFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GreaterOrEqualFunction:interface", "docComment": "/**\n * Function `GreaterOrEqual`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GreaterOrEqualFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/GreaterOrEqualFunction.d.ts", "releaseTag": "Public", "name": "GreaterOrEqualFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!GroupBookmarkItem:interface", "docComment": "/**\n * {@link Bookmark} item representing a group that contains other bookmark items.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface GroupBookmarkItem extends " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/bookmark-items/GroupBookmarkItem.d.ts", "releaseTag": "Public", "name": "GroupBookmarkItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GroupBookmarkItem#items:member", "docComment": "/**\n * Child bookmark items contained in this group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GroupBookmarkItem#title:member", "docComment": "/**\n * Display title of this bookmark group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!GroupBookmarkItem#type:member", "docComment": "/**\n * Discriminator indicating this is a group bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'group'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HardWrapOptions:interface", "docComment": "/**\n * Options for hard-wrapping text in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HardWrapOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/HardWrapOptions.d.ts", "releaseTag": "Public", "name": "HardWrapOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HardWrapOptions#allowMerge:member", "docComment": "/**\n * Whether to allow merging short lines together.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowMerge?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "allowMerge", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HardWrapOptions#column:member", "docComment": "/**\n * The column number at which to wrap lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "column?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "column", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HardWrapOptions#from:member", "docComment": "/**\n * Starting line number to begin wrapping from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HardWrapOptions#to:member", "docComment": "/**\n * Ending line number to stop wrapping at.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HasCompare:interface", "docComment": "/**\n * Has compare.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HasCompare " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/HasCompare.d.ts", "releaseTag": "Public", "name": "HasCompare", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HasCompare#compare:member(1)", "docComment": "/**\n * Compares two values.\n *\n * @param a - The first value to compare.\n *\n * @param b - The second value to compare.\n *\n * @returns Whether the comparison is satisfied.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compare(a: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", b: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "a", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "compare" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HasExtract:interface", "docComment": "/**\n * Has extract.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HasExtract " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/HasExtract.d.ts", "releaseTag": "Public", "name": "HasExtract", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HasExtract#extract:member(1)", "docComment": "/**\n * Extracts a date.\n *\n * @param date - The date to extract from.\n *\n * @returns The extracted numeric value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extract(date: " }, { "kind": "Reference", "text": "Date", "canonicalReference": "!Date:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "date", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "extract" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface", "docComment": "/**\n * Has get display name.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HasGetDisplayName " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/HasGetDisplayName.d.ts", "releaseTag": "Public", "name": "HasGetDisplayName", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HasGetDisplayName#getDisplayName:member(1)", "docComment": "/**\n * Gets the display name.\n *\n * @param type - The type to get the display name for.\n *\n * @returns The display name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDisplayName(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDisplayName" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface", "docComment": "/**\n * Has get RHS widget type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HasGetRHSWidgetType " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/HasGetRHSWidgetType.d.ts", "releaseTag": "Public", "name": "HasGetRHSWidgetType", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType#getRHSWidgetType:member(1)", "docComment": "/**\n * Gets the RHS widget type.\n *\n * @param type - The type to get the RHS widget type for.\n *\n * @returns The RHS widget type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRHSWidgetType(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getRHSWidgetType" } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!hasLoadedNamespace:var", "docComment": "/**\n * Checks whether a namespace has been loaded.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasLoadedNamespace: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['hasLoadedNamespace']" } ], "fileUrlPath": "src/i18next/internals/functions/hasLoadedNamespace.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "hasLoadedNamespace", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HasLoadedNamespaceOptions:interface", "docComment": "/**\n * Options for checking whether a namespace has been loaded.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HasLoadedNamespaceOptions " } ], "fileUrlPath": "src/i18next/internals/HasLoadedNamespaceOptions.d.ts", "releaseTag": "Public", "name": "HasLoadedNamespaceOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HasLoadedNamespaceOptions#lng:member", "docComment": "/**\n * Language code to check.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lng?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lng", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HeaderDom:interface", "docComment": "/**\n * Renders navigation buttons and sort controls for a section header in the backlink view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HeaderDom " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/backlink/HeaderDom.d.ts", "releaseTag": "Public", "name": "HeaderDom", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HeaderDom#addNavButton:member(1)", "docComment": "/**\n * Add a navigation button to the header.\n *\n * @returns The created navigation button element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addNavButton(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg4: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "arg4", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "addNavButton" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HeaderDom#addSortButton:member(1)", "docComment": "/**\n * Add a sort button to the header.\n *\n * @returns The created sort button element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSortButton(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg4: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "arg4", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "addSortButton" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HeaderDom#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HeaderDom#navButtonsEl:member", "docComment": "/**\n * Container element for navigation buttons.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "navButtonsEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "navButtonsEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HeaderDom#navHeaderEl:member", "docComment": "/**\n * Container element for the navigation header.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "navHeaderEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "navHeaderEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HeadingInfo:interface", "docComment": "/**\n * Information about a heading section in a note, including its text and position range.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HeadingInfo " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/note-composer/HeadingInfo.d.ts", "releaseTag": "Public", "name": "HeadingInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HeadingInfo#end:member", "docComment": "/**\n * End position of the heading section in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "end: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "end", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HeadingInfo#heading:member", "docComment": "/**\n * The heading text content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "heading: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "heading", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HeadingInfo#start:member", "docComment": "/**\n * Start position of the heading section in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "start", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!highlight:function(1)", "docComment": "/**\n * Highlights a string of code using the given grammar.\n *\n * @param text - The code string to highlight.\n *\n * @param grammar - The grammar to use for tokenization.\n *\n * @param language - The language identifier.\n *\n * @returns The highlighted HTML string.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function highlight(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", grammar: " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": ", language: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/functions/highlight.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "grammar", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "language", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "highlight" }, { "kind": "Function", "canonicalReference": "obsidian-typings!highlightAll:function(1)", "docComment": "/**\n * Highlights all code elements on the page.\n *\n * @param async - Whether to use web workers for highlighting.\n *\n * @param callback - Callback invoked after each element is highlighted.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function highlightAll(async?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "HighlightCallback", "canonicalReference": "obsidian-typings!HighlightCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/functions/highlightAll.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "async", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "highlightAll" }, { "kind": "Function", "canonicalReference": "obsidian-typings!highlightAllUnder:function(1)", "docComment": "/**\n * Highlights all code elements under a given container.\n *\n * @param container - The parent node to search within.\n *\n * @param async - Whether to use web workers for highlighting.\n *\n * @param callback - Callback invoked after each element is highlighted.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function highlightAllUnder(container: " }, { "kind": "Reference", "text": "ParentNode", "canonicalReference": "!ParentNode:interface" }, { "kind": "Content", "text": ", async?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "HighlightCallback", "canonicalReference": "obsidian-typings!HighlightCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/functions/highlightAllUnder.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "container", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "async", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "highlightAllUnder" }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!HighlightCallback:type", "docComment": "/**\n * Callback invoked after an element is highlighted.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type HighlightCallback = " }, { "kind": "Content", "text": "(element: " }, { "kind": "Reference", "text": "Element", "canonicalReference": "!Element:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/HighlightCallback.d.ts", "releaseTag": "Public", "name": "HighlightCallback", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Function", "canonicalReference": "obsidian-typings!highlightElement:function(1)", "docComment": "/**\n * Highlights a single code element.\n *\n * @param element - The element to highlight.\n *\n * @param async - Whether to use web workers for highlighting.\n *\n * @param callback - Callback invoked after the element is highlighted.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function highlightElement(element: " }, { "kind": "Reference", "text": "Element", "canonicalReference": "!Element:interface" }, { "kind": "Content", "text": ", async?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "HighlightCallback", "canonicalReference": "obsidian-typings!HighlightCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/functions/highlightElement.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "async", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "highlightElement" }, { "kind": "Class", "canonicalReference": "obsidian-typings!HighlightOutline:class", "docComment": "/**\n * Outline representing a PDF text highlight annotation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class HighlightOutline extends " }, { "kind": "Reference", "text": "Outline", "canonicalReference": "obsidian-typings!Outline:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/pdfjs-dist/internals/HighlightOutline.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "HighlightOutline", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!HighlightOutline:constructor(1)", "docComment": "/**\n * Create a highlight outline from the given outlines, bounding box, and last point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(outlines: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", box: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", lastPoint: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "outlines", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "box", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "lastPoint", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!HighlightOutline#box:member", "docComment": "/**\n * The bounding box of the highlight outline.\n *\n * @returns The bounding box, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get box(): " }, { "kind": "Content", "text": "null | object" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "box", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!HighlightOutline#classNamesForOutlining:member", "docComment": "/**\n * CSS class names applied when outlining this highlight.\n *\n * @returns The class names for outlining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get classNamesForOutlining(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "classNamesForOutlining", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!HighlightOutline#lastPoint:member", "docComment": "/**\n * The last point of the highlight used for directional calculations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastPoint: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastPoint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!HighlightOutline#serialize:member(1)", "docComment": "/**\n * Serialize the outlines into the PDF page coordinate system.\n *\n * @param bbox - the bounding box of the annotation.\n *\n * @param rotation - the rotation of the annotation.\n *\n * @returns Serialized outlines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialize(bbox: " }, { "kind": "Content", "text": "[blX: string, blY: string, trX: string, trY: string]" }, { "kind": "Content", "text": ", rotation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<number>>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "bbox", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "rotation", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "serialize" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!HighlightOutliner:class", "docComment": "/**\n * Generates outlines around highlighted regions in a PDF document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class HighlightOutliner " } ], "fileUrlPath": "src/pdfjs-dist/internals/HighlightOutliner.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "HighlightOutliner", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!HighlightOutliner:constructor(1)", "docComment": "/**\n * Construct an outliner.\n *\n * @param boxes - An array of axis-aligned rectangles.\n *\n * @param borderWidth - The width of the border of the boxes, it. allows to make the boxes bigger (or smaller).\n *\n * @param innerMargin - The margin between the boxes and the. outlines. It's important to not have a `null` innerMargin when we want to. draw the outline else the stroked outline could be clipped because of its. width.\n *\n * @param isLTR - `true` if we're in LTR mode. It's used to determine. the last point of the boxes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(boxes: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<object>" }, { "kind": "Content", "text": ", borderWidth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", innerMargin?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", isLTR?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "boxes", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "borderWidth", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "innerMargin", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true }, { "parameterName": "isLTR", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!HighlightOutliner#getOutlines:member(1)", "docComment": "/**\n * Compute and return the highlight outlines for the given boxes.\n *\n * @returns The computed highlight outlines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOutlines(): " }, { "kind": "Reference", "text": "HighlightOutline", "canonicalReference": "obsidian-typings!HighlightOutline:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getOutlines" } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!HookCallback:type", "docComment": "/**\n * Callback function invoked by a Prism hook.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type HookCallback = " }, { "kind": "Content", "text": "(env: " }, { "kind": "Reference", "text": "Environment", "canonicalReference": "obsidian-typings!Environment:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/HookCallback.d.ts", "releaseTag": "Public", "name": "HookCallback", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HookEvent:interface", "docComment": "/**\n * Event data passed to DOMPurify hooks during sanitization.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HookEvent " } ], "fileUrlPath": "src/dompurify/internals/HookEvent.d.ts", "releaseTag": "Public", "name": "HookEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HookEvent#allowedTags:member", "docComment": "/**\n * Record of currently allowed tags.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowedTags: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, boolean>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "allowedTags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HookEvent#tagName:member", "docComment": "/**\n * The tag name of the current element being processed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tagName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tagName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!HookName:type", "docComment": "/**\n * Names of hooks available in DOMPurify's sanitization lifecycle.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type HookName =\n " }, { "kind": "Content", "text": "| 'afterSanitizeAttributes'\n | 'afterSanitizeElements'\n | 'afterSanitizeShadowDOM'\n | 'beforeSanitizeAttributes'\n | 'beforeSanitizeElements'\n | 'beforeSanitizeShadowDOM'\n | 'uponSanitizeAttribute'\n | 'uponSanitizeElement'\n | 'uponSanitizeShadowNode'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/dompurify/internals/HookName.d.ts", "releaseTag": "Public", "name": "HookName", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "obsidian-typings!hooks:var", "docComment": "/**\n * Prism hook system for extending highlighting behavior.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hooks: " }, { "kind": "Reference", "text": "PrismHooks", "canonicalReference": "obsidian-typings!PrismHooks:interface" } ], "fileUrlPath": "src/prismjs/internals/vars/hooks.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "hooks", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!HookTypes:type", "docComment": "/**\n * Map of hook names to their registered callback arrays.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type HookTypes = " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "HookCallback", "canonicalReference": "obsidian-typings!HookCallback:type" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/HookTypes.d.ts", "releaseTag": "Public", "name": "HookTypes", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HotkeyManager:interface", "docComment": "/**\n * Manager for keyboard shortcut registration, storage, and triggering.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HotkeyManager " } ], "fileUrlPath": "src/obsidian/internals/hotkey-manager/HotkeyManager.d.ts", "releaseTag": "Public", "name": "HotkeyManager", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#addDefaultHotkeys:member(1)", "docComment": "/**\n * Add a hotkey to the default hotkeys.\n *\n * @param command - {@link obsidian#Command} ID to add hotkey to.\n *\n * @param keys - Hotkeys to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addDefaultHotkeys(command: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", keys: " }, { "kind": "Reference", "text": "KeymapInfo", "canonicalReference": "obsidian!KeymapInfo:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "keys", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "addDefaultHotkeys" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HotkeyManager#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#bake:member(1)", "docComment": "/**\n * Bake hotkeys (create mapping of pressed key to command ID).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bake(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "bake" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HotkeyManager#baked:member", "docComment": "/**\n * Whether hotkeys have been baked (checks completed).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "baked: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "baked", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HotkeyManager#bakedHotkeys:member", "docComment": "/**\n * Assigned hotkeys.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bakedHotkeys: " }, { "kind": "Reference", "text": "KeymapInfo", "canonicalReference": "obsidian!KeymapInfo:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bakedHotkeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HotkeyManager#bakedIds:member", "docComment": "/**\n * Array of hotkey index to command ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bakedIds: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bakedIds", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getHotkeyManagerConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HotkeyManager#customKeys:member", "docComment": "/**\n * Custom (non-Obsidian default) hotkeys, one to many mapping of command ID to assigned hotkey.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "customKeys: " }, { "kind": "Reference", "text": "HotkeyManagerCustomKeysRecord", "canonicalReference": "obsidian-typings!HotkeyManagerCustomKeysRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "customKeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HotkeyManager#defaultKeys:member", "docComment": "/**\n * Default hotkeys, one to many mapping of command ID to assigned hotkey.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultKeys: " }, { "kind": "Reference", "text": "HotkeyManagerDefaultKeysRecord", "canonicalReference": "obsidian-typings!HotkeyManagerDefaultKeysRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultKeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#getDefaultHotkeys:member(1)", "docComment": "/**\n * Get hotkey associated with command ID.\n *\n * @param command - {@link obsidian#Command} ID to get hotkey for.\n *\n * @returns The default hotkeys for the command.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDefaultHotkeys(command: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "KeymapInfo", "canonicalReference": "obsidian!KeymapInfo:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDefaultHotkeys" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#getHotkeys:member(1)", "docComment": "/**\n * Get hotkey associated with command ID.\n *\n * @param command - {@link obsidian#Command} ID to get hotkey for.\n *\n * @returns The hotkeys for the command.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHotkeys(command: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "KeymapInfo", "canonicalReference": "obsidian!KeymapInfo:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getHotkeys" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#load:member(1)", "docComment": "/**\n * Load hotkeys from storage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "load(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "load" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HotkeyManager#onConfigFileChange:member", "docComment": "/**\n * Debounced handler for hotkey config file changes on disk.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onConfigFileChange: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onConfigFileChange", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#onRaw:member(1)", "docComment": "/**\n * Handle raw file system change events for the hotkey config.\n *\n * @param e - The file system change event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRaw(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onRaw" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#onTrigger:member(1)", "docComment": "/**\n * Trigger a command by keyboard event.\n *\n * @param event - Keyboard event to trigger command with.\n *\n * @param keypress - Pressed key information.\n *\n * @returns Whether a command was triggered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTrigger(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": ", keypress: " }, { "kind": "Reference", "text": "KeymapInfo", "canonicalReference": "obsidian!KeymapInfo:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "keypress", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onTrigger" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#printHotkeyForCommand:member(1)", "docComment": "/**\n * Pretty-print hotkey of a command.\n *\n * @param commandId - {@link obsidian#Command} ID to print hotkey for.\n *\n * @returns The formatted hotkey string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "printHotkeyForCommand(commandId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "commandId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "printHotkeyForCommand" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#registerListeners:member(1)", "docComment": "/**\n * Register event listeners for hotkey config file changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerListeners(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "registerListeners" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#removeDefaultHotkeys:member(1)", "docComment": "/**\n * Remove a hotkey from the default hotkeys.\n *\n * @param command - {@link obsidian#Command} ID to remove hotkey from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeDefaultHotkeys(command: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeDefaultHotkeys" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#removeHotkeys:member(1)", "docComment": "/**\n * Remove a hotkey from the custom hotkeys.\n *\n * @param command - {@link obsidian#Command} ID to remove hotkey from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeHotkeys(command: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeHotkeys" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#save:member(1)", "docComment": "/**\n * Save custom hotkeys to storage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "save(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "save" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeyManager#setHotkeys:member(1)", "docComment": "/**\n * Add a hotkey to the custom hotkeys (overrides default hotkeys).\n *\n * @param command - {@link obsidian#Command} ID to add hotkey to.\n *\n * @param keys - Hotkeys to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHotkeys(command: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", keys: " }, { "kind": "Reference", "text": "KeymapInfo", "canonicalReference": "obsidian!KeymapInfo:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "keys", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "setHotkeys" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HotkeyManagerCustomKeysRecord:interface", "docComment": "/**\n * Record mapping command IDs to their user-customized hotkey bindings.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HotkeyManagerCustomKeysRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "KeymapInfo", "canonicalReference": "obsidian!KeymapInfo:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/hotkey-manager/HotkeyManagerCustomKeysRecord.d.ts", "releaseTag": "Public", "name": "HotkeyManagerCustomKeysRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HotkeyManagerDefaultKeysRecord:interface", "docComment": "/**\n * Record mapping command IDs to their default hotkey bindings.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HotkeyManagerDefaultKeysRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "KeymapInfo", "canonicalReference": "obsidian!KeymapInfo:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/hotkey-manager/HotkeyManagerDefaultKeysRecord.d.ts", "releaseTag": "Public", "name": "HotkeyManagerDefaultKeysRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HotkeysSettingTab:interface", "docComment": "/**\n * Setting tab for viewing and editing keyboard hotkeys.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HotkeysSettingTab extends " }, { "kind": "Reference", "text": "SettingTab", "canonicalReference": "obsidian!SettingTab:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/HotkeysSettingTab.d.ts", "releaseTag": "Public", "name": "HotkeysSettingTab", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HotkeysSettingTab#searchComponent:member", "docComment": "/**\n * Search component for filtering hotkeys by name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchComponent: " }, { "kind": "Reference", "text": "SearchComponent", "canonicalReference": "obsidian!SearchComponent:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchComponent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!HotkeysSettingTab#updateHotkeyVisibility:member(1)", "docComment": "/**\n * Update visibility of hotkey entries based on the current search filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateHotkeyVisibility(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateHotkeyVisibility" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HourFunction:interface", "docComment": "/**\n * Function `Hour`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HourFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasExtract", "canonicalReference": "obsidian-typings!HasExtract:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/HourFunction.d.ts", "releaseTag": "Public", "name": "HourFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HoverLinkEvent:interface", "docComment": "/**\n * Event triggered when a link is hovered.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HoverLinkEvent " } ], "fileUrlPath": "src/obsidian/internals/HoverLinkEvent.d.ts", "releaseTag": "Public", "name": "HoverLinkEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HoverLinkEvent#event:member", "docComment": "/**\n * The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "event", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HoverLinkEvent#hoverParent:member", "docComment": "/**\n * The hover parent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverParent: " }, { "kind": "Reference", "text": "HoverParent", "canonicalReference": "obsidian!HoverParent:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverParent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HoverLinkEvent#linktext:member", "docComment": "/**\n * The link text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linktext: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "linktext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HoverLinkEvent#source:member", "docComment": "/**\n * The source of the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "source: " }, { "kind": "Content", "text": "'editor' | 'file-explorer' | 'graph' | 'hover-link' | 'preview' | 'properties' | 'search'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HoverLinkEvent#sourcePath:member", "docComment": "/**\n * The source path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourcePath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sourcePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HoverLinkEvent#state:member", "docComment": "/**\n * The state of the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state?: " }, { "kind": "Reference", "text": "HoverLinkEventState", "canonicalReference": "obsidian-typings!HoverLinkEventState:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HoverLinkEvent#targetEl:member", "docComment": "/**\n * The target element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "targetEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!HoverLinkEventState:interface", "docComment": "/**\n * State passed with hover link events.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HoverLinkEventState " } ], "fileUrlPath": "src/obsidian/internals/HoverLinkEventState.d.ts", "releaseTag": "Public", "name": "HoverLinkEventState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!HoverLinkEventState#scroll:member", "docComment": "/**\n * Scroll position at the time of the hover event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scroll: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!I18n:interface", "docComment": "/**\n * Main i18next instance interface.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface I18n " } ], "fileUrlPath": "src/i18next/internals/I18n.d.ts", "releaseTag": "Public", "name": "I18n", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#addResource:member(1)", "docComment": "/**\n * Adds a single resource entry.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @param key - Resource key.\n *\n * @param value - Resource value.\n *\n * @param options - Additional options including `keySeparator` and `silent`.\n *\n * @returns The i18n instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addResource(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "AddResourceOptions", "canonicalReference": "obsidian-typings!AddResourceOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "name": "addResource" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#addResourceBundle:member(1)", "docComment": "/**\n * Adds a resource bundle.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @param resources - Bundle of resources.\n *\n * @param deep - Whether to deep merge.\n *\n * @param overwrite - Whether to overwrite existing keys.\n *\n * @returns The i18n instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addResourceBundle(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", resources: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ", deep?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", overwrite?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "resources", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": false }, { "parameterName": "deep", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "isOptional": true }, { "parameterName": "overwrite", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "isOptional": true } ], "name": "addResourceBundle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#addResources:member(1)", "docComment": "/**\n * Adds multiple resource entries.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @param resources - Resource entries.\n *\n * @returns The i18n instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addResources(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", resources: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "resources", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": false } ], "name": "addResources" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#changeLanguage:member(1)", "docComment": "/**\n * Changes the active language.\n *\n * @param lng - Language code.\n *\n * @param callback - Optional callback.\n *\n * @returns A promise resolving to the translation function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeLanguage(lng?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "Callback", "canonicalReference": "obsidian-typings!Callback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFunction", "canonicalReference": "obsidian-typings!TFunction:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "changeLanguage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#cloneInstance:member(1)", "docComment": "/**\n * Creates a new i18next instance.\n *\n * @param options - Initialization options.\n *\n * @param callback - Optional callback.\n *\n * @returns A new i18n instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cloneInstance(options?: " }, { "kind": "Reference", "text": "InitOptions", "canonicalReference": "obsidian-typings!InitOptions:interface" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "Callback", "canonicalReference": "obsidian-typings!Callback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "cloneInstance" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#createInstance:member(1)", "docComment": "/**\n * Creates a new i18next instance.\n *\n * @param options - Initialization options.\n *\n * @param callback - Optional callback.\n *\n * @returns A new i18n instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createInstance(options?: " }, { "kind": "Reference", "text": "InitOptions", "canonicalReference": "obsidian-typings!InitOptions:interface" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "Callback", "canonicalReference": "obsidian-typings!Callback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "createInstance" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#dir:member(1)", "docComment": "/**\n * Returns the text direction for a language.\n *\n * @param lng - Language code.\n *\n * @returns The text direction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dir(lng?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "'ltr' | 'rtl'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "dir" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#emit:member(1)", "docComment": "/**\n * Emits an event.\n *\n * @param event - Event name.\n *\n * @param args - Event arguments.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "emit(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "emit" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#exists:member(1)", "docComment": "/**\n * Checks whether a translation key exists.\n *\n * @param key - Translation key.\n *\n * @param options - Additional options.\n *\n * @returns Whether the key exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exists(key: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": true } ], "name": "exists" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#format:member(1)", "docComment": "/**\n * Formats a value.\n *\n * @param value - The value to format.\n *\n * @param format - The format string.\n *\n * @param lng - Language code.\n *\n * @param options - Additional options.\n *\n * @returns The formatted string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "format(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", format?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", lng?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "format", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "isOptional": true } ], "name": "format" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#getDataByLanguage:member(1)", "docComment": "/**\n * Gets all resource data for a language.\n *\n * @param lng - Language code.\n *\n * @returns The resource data or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDataByLanguage(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>> | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDataByLanguage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#getFixedT:member(1)", "docComment": "/**\n * Gets a translation function fixed to a language and namespace.\n *\n * @param lng - Language code or codes.\n *\n * @param ns - Namespace or namespaces.\n *\n * @returns A fixed translation function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFixedT(lng: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ", ns?: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TFunction", "canonicalReference": "obsidian-typings!TFunction:type" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getFixedT" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#getResource:member(1)", "docComment": "/**\n * Gets a single resource value.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @param key - Resource key.\n *\n * @param options - Additional options including `keySeparator`.\n *\n * @returns The resource value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getResource(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "GetResourceOptions", "canonicalReference": "obsidian-typings!GetResourceOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "getResource" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#getResourceBundle:member(1)", "docComment": "/**\n * Gets a resource bundle for a language and namespace.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @returns The resource bundle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getResourceBundle(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getResourceBundle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#hasLoadedNamespace:member(1)", "docComment": "/**\n * Checks whether a namespace has been loaded.\n *\n * @param ns - Namespace or namespaces.\n *\n * @param options - Additional options including `lng`.\n *\n * @returns Whether the namespace has been loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasLoadedNamespace(ns: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "HasLoadedNamespaceOptions", "canonicalReference": "obsidian-typings!HasLoadedNamespaceOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "hasLoadedNamespace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#hasResourceBundle:member(1)", "docComment": "/**\n * Checks whether a resource bundle exists.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @returns Whether the bundle exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasResourceBundle(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "hasResourceBundle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#init:member(1)", "docComment": "/**\n * Initializes the i18next instance.\n *\n * @param options - Initialization options.\n *\n * @param callback - Optional callback.\n *\n * @returns A promise resolving to the translation function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "init(options?: " }, { "kind": "Reference", "text": "InitOptions", "canonicalReference": "obsidian-typings!InitOptions:interface" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "Callback", "canonicalReference": "obsidian-typings!Callback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFunction", "canonicalReference": "obsidian-typings!TFunction:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "init" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#isInitialized:member", "docComment": "/**\n * Whether the instance has been initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isInitialized: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isInitialized", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#isInitializing:member", "docComment": "/**\n * Whether the instance is currently initializing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isInitializing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isInitializing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#isLanguageChangingTo:member", "docComment": "/**\n * The language a change is currently in progress to, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isLanguageChangingTo?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isLanguageChangingTo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#language:member", "docComment": "/**\n * The active language code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "language: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "language", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#languages:member", "docComment": "/**\n * The list of languages in fallback order.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "languages: " }, { "kind": "Content", "text": "readonly string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "languages", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#loadLanguages:member(1)", "docComment": "/**\n * Loads additional languages.\n *\n * @param lngs - Language code or codes.\n *\n * @param callback - Optional callback.\n *\n * @returns A promise that resolves when loading is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadLanguages(lngs: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "Callback", "canonicalReference": "obsidian-typings!Callback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lngs", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadLanguages" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#loadNamespaces:member(1)", "docComment": "/**\n * Loads additional namespaces.\n *\n * @param ns - Namespace or namespaces.\n *\n * @param callback - Optional callback.\n *\n * @returns A promise that resolves when loading is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadNamespaces(ns: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "Callback", "canonicalReference": "obsidian-typings!Callback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadNamespaces" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#loadResources:member(1)", "docComment": "/**\n * Loads resources using the configured backend.\n *\n * @param callback - Optional callback.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadResources(callback?: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "loadResources" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#logger:member", "docComment": "/**\n * The i18next logger instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "logger: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "logger", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#modules:member", "docComment": "/**\n * Loaded plugin modules.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modules: " }, { "kind": "Reference", "text": "I18nModules", "canonicalReference": "obsidian-typings!I18nModules:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modules", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#observers:member", "docComment": "/**\n * The registered event observers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "observers: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "observers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#off:member(1)", "docComment": "/**\n * Removes a listener for an event.\n *\n * @param event - Event name.\n *\n * @param listener - Listener function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener?: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#on:member(1)", "docComment": "/**\n * Registers a listener for an event.\n *\n * @param event - Event name.\n *\n * @param listener - Listener function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#options:member", "docComment": "/**\n * The resolved initialization options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "InitOptions", "canonicalReference": "obsidian-typings!InitOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#reloadResources:member(1)", "docComment": "/**\n * Reloads resources for the given languages and namespaces.\n *\n * @param lngs - Language codes, or `null` for all.\n *\n * @param ns - Namespaces, or `null` for all.\n *\n * @param callback - Optional callback.\n *\n * @returns A promise that resolves when reloading is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reloadResources(lngs?: " }, { "kind": "Content", "text": "null | string[]" }, { "kind": "Content", "text": ", ns?: " }, { "kind": "Content", "text": "null | string[]" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lngs", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "reloadResources" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#removeResourceBundle:member(1)", "docComment": "/**\n * Removes a resource bundle.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @returns The i18n instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeResourceBundle(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeResourceBundle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#resolvedLanguage:member", "docComment": "/**\n * The resolved language, if available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolvedLanguage?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "resolvedLanguage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#services:member", "docComment": "/**\n * The services container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "services: " }, { "kind": "Reference", "text": "Services", "canonicalReference": "obsidian-typings!Services:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "services", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#setDefaultNamespace:member(1)", "docComment": "/**\n * Sets the default namespace.\n *\n * @param ns - Namespace.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDefaultNamespace(ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setDefaultNamespace" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#store:member", "docComment": "/**\n * The resource store.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "store: " }, { "kind": "Reference", "text": "ResourceStore", "canonicalReference": "obsidian-typings!ResourceStore:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "store", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#t:member", "docComment": "/**\n * The translation function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "t: " }, { "kind": "Reference", "text": "TFunction", "canonicalReference": "obsidian-typings!TFunction:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "t", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18n#translator:member", "docComment": "/**\n * The i18next translator instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "translator: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "translator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!I18n#use:member(1)", "docComment": "/**\n * Registers a plugin module.\n *\n * @param module - The module, its constructor, or a factory function.\n *\n * @returns The i18n instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "use<T extends " }, { "kind": "Reference", "text": "Module", "canonicalReference": "obsidian-typings!Module:interface" }, { "kind": "Content", "text": ">(module: " }, { "kind": "Content", "text": "((instance: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": ") => void) | " }, { "kind": "Reference", "text": "ModuleConstructor", "canonicalReference": "obsidian-typings!ModuleConstructor:interface" }, { "kind": "Content", "text": "<T> | T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "module", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "use" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!I18nModules:interface", "docComment": "/**\n * Container for loaded i18next plugin modules.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface I18nModules " } ], "fileUrlPath": "src/i18next/internals/I18nModules.d.ts", "releaseTag": "Public", "name": "I18nModules", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!I18nModules#external:member", "docComment": "/**\n * External plugin modules.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "external: " }, { "kind": "Reference", "text": "Module", "canonicalReference": "obsidian-typings!Module:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "external", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IApplicationOptions:interface", "docComment": "/**\n * Application options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IApplicationOptions " } ], "fileUrlPath": "src/pixi.js/internals/IApplicationOptions.d.ts", "releaseTag": "Public", "name": "IApplicationOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#antialias:member", "docComment": "/**\n * Whether the renderer should use antialiasing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "antialias?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "antialias", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#autoDensity:member", "docComment": "/**\n * Whether to automatically adjust for device pixel ratio.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoDensity?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autoDensity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#autoStart:member", "docComment": "/**\n * Whether to automatically start the render loop.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoStart?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autoStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#backgroundAlpha:member", "docComment": "/**\n * Background alpha.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundAlpha?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "backgroundAlpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#backgroundColor:member", "docComment": "/**\n * Background color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundColor?: " }, { "kind": "Reference", "text": "ColorSource", "canonicalReference": "obsidian-typings!ColorSource:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "backgroundColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#clearBeforeRender:member", "docComment": "/**\n * Whether to clear before each render.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearBeforeRender?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "clearBeforeRender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#forceCanvas:member", "docComment": "/**\n * Whether to force the canvas renderer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forceCanvas?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "forceCanvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#height:member", "docComment": "/**\n * Height of the renderer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#powerPreference:member", "docComment": "/**\n * Power preference for the WebGL context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "powerPreference?: " }, { "kind": "Reference", "text": "WebGLPowerPreference", "canonicalReference": "!WebGLPowerPreference:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "powerPreference", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#preserveDrawingBuffer:member", "docComment": "/**\n * Whether to preserve the drawing buffer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preserveDrawingBuffer?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "preserveDrawingBuffer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#resizeTo:member", "docComment": "/**\n * Element to resize the renderer to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resizeTo?: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Window", "canonicalReference": "!Window:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "resizeTo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#resolution:member", "docComment": "/**\n * Renderer resolution.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolution?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "resolution", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#sharedLoader:member", "docComment": "/**\n * Whether to use a shared loader.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sharedLoader?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sharedLoader", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#sharedTicker:member", "docComment": "/**\n * Whether to use a shared ticker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sharedTicker?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sharedTicker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#transparent:member", "docComment": "/**\n * Whether the renderer background is transparent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transparent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "transparent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#view:member", "docComment": "/**\n * Canvas view to use.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "view?: " }, { "kind": "Reference", "text": "ICanvas", "canonicalReference": "obsidian-typings!ICanvas:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IApplicationOptions#width:member", "docComment": "/**\n * Width of the renderer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ICanvas:interface", "docComment": "/**\n * Canvas interface for PixiJS rendering.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ICanvas extends " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EventTarget", "canonicalReference": "!EventTarget:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/pixi.js/internals/ICanvas.d.ts", "releaseTag": "Public", "name": "ICanvas", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ICanvas#getContext:member(1)", "docComment": "/**\n * Returns a 2D rendering context.\n *\n * @param contextId - Context identifier.\n *\n * @param options - Context attributes.\n *\n * @returns The 2D rendering context, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getContext(contextId: " }, { "kind": "Content", "text": "'2d'" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "CanvasRenderingContext2DSettings", "canonicalReference": "!CanvasRenderingContext2DSettings:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CanvasRenderingContext2D", "canonicalReference": "!CanvasRenderingContext2D:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "contextId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getContext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ICanvas#getContext:member(2)", "docComment": "/**\n * Returns a WebGL rendering context.\n *\n * @param contextId - Context identifier.\n *\n * @param options - Context attributes.\n *\n * @returns The WebGL rendering context, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getContext(contextId: " }, { "kind": "Content", "text": "'experimental-webgl' | 'webgl'" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "WebGLContextAttributes", "canonicalReference": "!WebGLContextAttributes:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "WebGLRenderingContext", "canonicalReference": "!WebGLRenderingContext:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "contextId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getContext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ICanvas#getContext:member(3)", "docComment": "/**\n * Returns a WebGL2 rendering context.\n *\n * @param contextId - Context identifier.\n *\n * @param options - Context attributes.\n *\n * @returns The WebGL2 rendering context, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getContext(contextId: " }, { "kind": "Content", "text": "'experimental-webgl2' | 'webgl2'" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "WebGLContextAttributes", "canonicalReference": "!WebGLContextAttributes:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "WebGL2RenderingContext", "canonicalReference": "!WebGL2RenderingContext:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "contextId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getContext" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ICanvas#height:member", "docComment": "/**\n * Canvas height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ICanvas#toBlob:member(1)", "docComment": "/**\n * Converts the canvas to a blob.\n *\n * @param callback - Callback receiving the blob.\n *\n * @param type - Image MIME type.\n *\n * @param quality - Image quality.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toBlob?(callback: " }, { "kind": "Content", "text": "(blob: " }, { "kind": "Reference", "text": "Blob", "canonicalReference": "!Blob:interface" }, { "kind": "Content", "text": " | null) => void" }, { "kind": "Content", "text": ", type?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", quality?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "quality", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "toBlob" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ICanvas#toDataURL:member(1)", "docComment": "/**\n * Converts the canvas to a data URL.\n *\n * @param type - Image MIME type.\n *\n * @param quality - Image quality.\n *\n * @returns The data URL string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toDataURL?(type?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", quality?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "quality", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "toDataURL" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ICanvas#width:member", "docComment": "/**\n * Canvas width.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!IconLoader:type", "docComment": "/**\n * Loader function for Mermaid icon packs.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type IconLoader = " }, { "kind": "Content", "text": "() => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/mermaid/internals/IconLoader.d.ts", "releaseTag": "Public", "name": "IconLoader", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IDestroyOptions:interface", "docComment": "/**\n * Options for destroying a display object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IDestroyOptions " } ], "fileUrlPath": "src/pixi.js/internals/IDestroyOptions.d.ts", "releaseTag": "Public", "name": "IDestroyOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IDestroyOptions#baseTexture:member", "docComment": "/**\n * Whether to destroy the base texture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "baseTexture?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "baseTexture", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IDestroyOptions#children:member", "docComment": "/**\n * Whether to destroy children.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "children?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IDestroyOptions#texture:member", "docComment": "/**\n * Whether to destroy the texture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "texture?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "texture", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IfFunction:interface", "docComment": "/**\n * Function `If`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IfFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/IfFunction.d.ts", "releaseTag": "Public", "name": "IfFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor:interface", "docComment": "/**\n * A markdown editor that runs inside an iframe, used for embedded editable views.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IFramedMarkdownEditor extends " }, { "kind": "Reference", "text": "MarkdownScrollableEditView", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/IFramedMarkdownEditor.d.ts", "releaseTag": "Public", "name": "IFramedMarkdownEditor", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor#cleanup:member", "docComment": "/**\n * Function that cleans up the iframe and listeners.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cleanup: " }, { "kind": "Content", "text": "(() => void) | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cleanup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor#cleanupIframe:member(1)", "docComment": "/**\n * Executes cleanup function if exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cleanupIframe(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cleanupIframe" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor#getDynamicExtensions:member(1)", "docComment": "/**\n * Constructs extensions for the editor based on user settings.\n *\n * @returns Array of dynamic CodeMirror extensions.\n *\n * @remark\n *\n * Creates extension for overriding escape keymap to showPreview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDynamicExtensions(): " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDynamicExtensions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor#iframeEl:member", "docComment": "/**\n * Element where the editor is embedded into.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iframeEl: " }, { "kind": "Reference", "text": "HTMLIFrameElement", "canonicalReference": "!HTMLIFrameElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "iframeEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor#onIframeLoad:member(1)", "docComment": "/**\n * Loads the iframe element and prepare cleanup function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onIframeLoad(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onIframeLoad" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor#onunload:member(1)", "docComment": "/**\n * Execute cleanup of the iframe.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onunload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onunload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IFramedMarkdownEditor#onUpdate:member(1)", "docComment": "/**\n * Execute functionality on CM editor state update.\n *\n * @param update - The CodeMirror view update.\n *\n * @param changed - Whether the document content changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onUpdate(update: " }, { "kind": "Reference", "text": "ViewUpdate", "canonicalReference": "@codemirror/view!ViewUpdate:class" }, { "kind": "Content", "text": ", changed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "update", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "changed", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onUpdate" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IHitArea:interface", "docComment": "/**\n * Hit area interface.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IHitArea " } ], "fileUrlPath": "src/pixi.js/internals/IHitArea.d.ts", "releaseTag": "Public", "name": "IHitArea", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IHitArea#contains:member(1)", "docComment": "/**\n * Checks whether the point is inside the hit area.\n *\n * @param x - X coordinate.\n *\n * @param y - Y coordinate.\n *\n * @returns Whether the point is contained.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contains(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "contains" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ImageView:interface", "docComment": "/**\n * View for displaying image files.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ImageView extends " }, { "kind": "Reference", "text": "EditableFileView", "canonicalReference": "obsidian!EditableFileView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/ImageView.d.ts", "releaseTag": "Public", "name": "ImageView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ImageView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The view type identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ImportedAttachment:interface", "docComment": "/**\n * Imported attachment.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ImportedAttachment " } ], "fileUrlPath": "src/obsidian/internals/ImportedAttachment.d.ts", "releaseTag": "Public", "name": "ImportedAttachment", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ImportedAttachment#data:member", "docComment": "/**\n * Promise that resolves to the attachment file content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ImportedAttachment#extension:member", "docComment": "/**\n * An attachment file extension.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extension: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "extension", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ImportedAttachment#filepath:member", "docComment": "/**\n * An attachment file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filepath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filepath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ImportedAttachment#name:member", "docComment": "/**\n * An attachment file name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IndexFunction:interface", "docComment": "/**\n * Function `Index`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IndexFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/IndexFunction.d.ts", "releaseTag": "Public", "name": "IndexFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InfinityScroll:interface", "docComment": "/**\n * Virtual scrolling component that renders only visible items in large lists for performance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InfinityScroll " } ], "fileUrlPath": "src/obsidian/internals/tree/InfinityScroll.d.ts", "releaseTag": "Public", "name": "InfinityScroll", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#_layout:member(1)", "docComment": "/**\n * Internal method to perform layout calculations.\n *\n * @param x - First layout parameter.\n *\n * @param y - Second layout parameter.\n *\n * @returns The layout calculation result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_layout(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "_layout" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#_measure:member(1)", "docComment": "/**\n * Internal method to measure element dimensions.\n *\n * @param x - The element to measure.\n *\n * @returns The measured dimensions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_measure(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "_measure" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#_precompute:member(1)", "docComment": "/**\n * Internal method to precompute layout information.\n *\n * @param x - The input data to precompute.\n *\n * @returns The precomputed layout data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_precompute(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "_precompute" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#compute:member(1)", "docComment": "/**\n * Compute visible items and update the virtual display.\n *\n * @param x - The computation input.\n *\n * @returns The computation result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compute(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "compute" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#findElementTop:member(1)", "docComment": "/**\n * Find the top position of an element within the scroll container.\n *\n * @param x - The element to find.\n *\n * @param y - Second parameter.\n *\n * @param z - Third parameter.\n *\n * @returns The top position of the element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findElementTop(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", z: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "z", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "findElementTop" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#getRootTop:member(1)", "docComment": "/**\n * Get the top offset of the root element.\n *\n * @returns The top offset of the root element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRootTop(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getRootTop" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InfinityScroll#height:member", "docComment": "/**\n * Current visible height of the scroll container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#invalidate:member(1)", "docComment": "/**\n * Invalidate the cached layout for specific items.\n *\n * @param x - First invalidation parameter.\n *\n * @param y - Second invalidation parameter.\n *\n * @returns The invalidation result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "invalidate(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "invalidate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#invalidateAll:member(1)", "docComment": "/**\n * Invalidate all cached layout information.\n *\n * @returns The invalidation result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "invalidateAll(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "invalidateAll" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InfinityScroll#lastScroll:member", "docComment": "/**\n * Last recorded scroll position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastScroll: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastScroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#measure:member(1)", "docComment": "/**\n * Measure dimensions for the given elements.\n *\n * @param x - First measurement parameter.\n *\n * @param y - Second measurement parameter.\n *\n * @returns The measurement result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "measure(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "measure" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#onResize:member(1)", "docComment": "/**\n * Handle resize events and recalculate layout.\n *\n * @returns The resize handling result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#onScroll:member(1)", "docComment": "/**\n * Handle scroll events and update the virtual display.\n *\n * @returns The scroll handling result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onScroll(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onScroll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#queueCompute:member(1)", "docComment": "/**\n * Queue a deferred computation of visible items.\n *\n * @returns The queued computation result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queueCompute(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "queueCompute" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InfinityScroll#queued:member", "docComment": "/**\n * Queued computation task, or `null` if none is pending.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queued: " }, { "kind": "Content", "text": "null | unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queued", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InfinityScroll#renderBlockSize:member", "docComment": "/**\n * Number of items to render per block.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderBlockSize: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderBlockSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InfinityScroll#rootEl:member", "docComment": "/**\n * Root element of the virtual scroll container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rootEl: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rootEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InfinityScroll#scrollEl:member", "docComment": "/**\n * Scrollable element that handles scroll events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scrollEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#scrollIntoView:member(1)", "docComment": "/**\n * Scroll the container to bring the specified element into view.\n *\n * @param x - The element to scroll into view.\n *\n * @param y - Scroll options.\n *\n * @returns The scroll result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollIntoView(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "scrollIntoView" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InfinityScroll#setWidth:member", "docComment": "/**\n * Whether the width should be explicitly set on items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setWidth: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "setWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#update:member(1)", "docComment": "/**\n * Update the virtual scroll state with new parameters.\n *\n * @param x - First update parameter.\n *\n * @param y - Second update parameter.\n *\n * @param z - Third update parameter.\n *\n * @param u - Fourth update parameter.\n *\n * @param v - Fifth update parameter.\n *\n * @param w - Sixth update parameter.\n *\n * @returns The update result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", z: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", u: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", v: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", w: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "z", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "u", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "v", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "w", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfinityScroll#updateVirtualDisplay:member(1)", "docComment": "/**\n * Update the virtual display to reflect current scroll position.\n *\n * @param x - The display update input.\n *\n * @returns The display update result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateVirtualDisplay(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateVirtualDisplay" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InfinityScroll#width:member", "docComment": "/**\n * Current visible width of the scroll container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InfoFileView:interface", "docComment": "/**\n * Info file view.\n *\n * @remark\n *\n * This is probably not the right term.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InfoFileView extends " }, { "kind": "Reference", "text": "FileView", "canonicalReference": "obsidian!FileView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/InfoFileView.d.ts", "releaseTag": "Public", "name": "InfoFileView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InfoFileView#onFileOpen:member(1)", "docComment": "/**\n * Called when a file is opened. Loads the file and requests a content update.\n *\n * @param file - The opened file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileOpen(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileOpen" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InFolderFunction:interface", "docComment": "/**\n * Function `InFolder`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InFolderFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/InFolderFunction.d.ts", "releaseTag": "Public", "name": "InFolderFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!init:var", "docComment": "/**\n * Initializes the i18next instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "init: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['init']" } ], "fileUrlPath": "src/i18next/internals/functions/init.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "init", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InitOptions:interface", "docComment": "/**\n * Configuration options for initializing i18next.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InitOptions " } ], "fileUrlPath": "src/i18next/internals/InitOptions.d.ts", "releaseTag": "Public", "name": "InitOptions", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!InitOptions:index(1)", "docComment": "/**\n * Additional options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#debug:member", "docComment": "/**\n * Whether to enable debug mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "debug?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "debug", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#defaultNS:member", "docComment": "/**\n * Default namespace to use.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultNS?: " }, { "kind": "Content", "text": "false | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultNS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#fallbackLng:member", "docComment": "/**\n * Fallback language or languages when translation is not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fallbackLng?: " }, { "kind": "Content", "text": "false | string | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fallbackLng", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#fallbackNS:member", "docComment": "/**\n * Fallback namespace or namespaces.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fallbackNS?: " }, { "kind": "Content", "text": "false | string | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fallbackNS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#interpolation:member", "docComment": "/**\n * Interpolation options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interpolation?: " }, { "kind": "Reference", "text": "InterpolationOptions", "canonicalReference": "obsidian-typings!InterpolationOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "interpolation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#lng:member", "docComment": "/**\n * Active language code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lng?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lng", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#ns:member", "docComment": "/**\n * Namespace or namespaces to load.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ns?: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ns", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#resources:member", "docComment": "/**\n * Pre-loaded translation resources.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resources?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "resources", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InitOptions#supportedLngs:member", "docComment": "/**\n * List of supported language codes, or `false` to allow all.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "supportedLngs?: " }, { "kind": "Content", "text": "false | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "supportedLngs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Input:interface", "docComment": "/**\n * Represents a document input for the parser.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Input " } ], "fileUrlPath": "src/@lezer__common/internals/Input.d.ts", "releaseTag": "Public", "name": "Input", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Input#chunk:member(1)", "docComment": "/**\n * Get a chunk of input starting at the given position.\n *\n * @param from - The start position.\n *\n * @returns The chunk string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "chunk(from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "chunk" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Input#length:member", "docComment": "/**\n * The total length of the input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Input#lineChunks:member", "docComment": "/**\n * Whether the input is divided into line-sized chunks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly lineChunks: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "lineChunks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Input#read:member(1)", "docComment": "/**\n * Read a range of input.\n *\n * @param from - The start position.\n *\n * @param to - The end position.\n *\n * @returns The string content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "read(from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "read" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InstallThemeOptions:interface", "docComment": "/**\n * Options for installing a theme from a repository.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InstallThemeOptions " } ], "fileUrlPath": "src/obsidian/internals/custom-css/InstallThemeOptions.d.ts", "releaseTag": "Public", "name": "InstallThemeOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InstallThemeOptions#author:member", "docComment": "/**\n * Author of the theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "author: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "author", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InstallThemeOptions#name:member", "docComment": "/**\n * Display name of the theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InstallThemeOptions#repo:member", "docComment": "/**\n * GitHub repository identifier (e.g. \"username/repo\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "repo: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "repo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InternalPlugin:interface", "docComment": "/**\n * Base interface for an internal plugin registration, managing lifecycle, commands, and views.\n *\n * @typeParam InternalPluginInstance - The type of the plugin instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InternalPlugin<InternalPluginInstance> extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/InternalPlugin.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "InternalPluginInstance", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "InternalPlugin", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#addedButtonEls:member", "docComment": "/**\n * Button elements added by this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addedButtonEls: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "addedButtonEls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#addSettingTab:member(1)", "docComment": "/**\n * Add a settings tab for this plugin.\n *\n * @param settingTab - The settings tab to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSettingTab(settingTab: " }, { "kind": "Reference", "text": "PluginSettingTab", "canonicalReference": "obsidian!PluginSettingTab:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "settingTab", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addSettingTab" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#commands:member", "docComment": "/**\n * {@link Commands} registered by this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commands: " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "commands", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#constructor2__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getInternalPluginConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @param instance - The instance.\n *\n * @param internalPlugins - The internalPlugins.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor2__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", instance: " }, { "kind": "Content", "text": "InternalPluginInstance" }, { "kind": "Content", "text": ", internalPlugins: " }, { "kind": "Reference", "text": "InternalPlugins", "canonicalReference": "obsidian-typings!InternalPlugins:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "instance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "internalPlugins", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "constructor2__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#deleteData:member(1)", "docComment": "/**\n * Delete persisted data for this plugin.\n *\n * @returns A promise that resolves when the data is deleted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deleteData(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "deleteData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#disable:member(1)", "docComment": "/**\n * Disable this plugin.\n *\n * @param isDisabledByUser - Whether the user manually disabled the plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disable(isDisabledByUser?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "isDisabledByUser", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "disable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#enable:member(1)", "docComment": "/**\n * Enable this plugin.\n *\n * @param isEnabledByUser - Whether the user manually enabled the plugin.\n *\n * @returns A promise that resolves when the plugin is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enable(isEnabledByUser?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "isEnabledByUser", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "enable" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#enabled:member", "docComment": "/**\n * Whether this plugin is currently enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#getModifiedTime:member(1)", "docComment": "/**\n * Get the last modified time of the plugin config file.\n *\n * @returns The modification timestamp, or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getModifiedTime(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<number | undefined>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getModifiedTime" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#handleConfigFileChange:member(1)", "docComment": "/**\n * Handle changes to the plugin config file.\n *\n * @returns A promise that resolves when the config change is processed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleConfigFileChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "handleConfigFileChange" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#hasStatusBarItem:member", "docComment": "/**\n * Whether this plugin has a status bar item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasStatusBarItem: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hasStatusBarItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#init:member(1)", "docComment": "/**\n * Initialize this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "init(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "init" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#instance:member", "docComment": "/**\n * The plugin instance containing the actual logic.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "instance: " }, { "kind": "Content", "text": "InternalPluginInstance" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "instance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#lastSave:member", "docComment": "/**\n * Timestamp of the last settings save.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastSave: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastSave", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#loadData:member(1)", "docComment": "/**\n * Load persisted data for this plugin.\n *\n * @returns The loaded data, or `null` if none exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadData(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | object>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadData" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#manager:member", "docComment": "/**\n * Reference to the internal plugins manager.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "manager: " }, { "kind": "Reference", "text": "InternalPlugins", "canonicalReference": "obsidian-typings!InternalPlugins:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "manager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#mobileFileInfo:member", "docComment": "/**\n * Mobile file info renderers registered by this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mobileFileInfo: " }, { "kind": "Reference", "text": "MobileFileInfo", "canonicalReference": "obsidian-typings!MobileFileInfo:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mobileFileInfo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#onConfigFileChange:member", "docComment": "/**\n * Debounced handler for config file changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onConfigFileChange: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onConfigFileChange", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#registerGlobalCommand:member(1)", "docComment": "/**\n * Register a global command for this plugin.\n *\n * @param command - The command to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerGlobalCommand(command: " }, { "kind": "Reference", "text": "Command", "canonicalReference": "obsidian!Command:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "registerGlobalCommand" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#registerMobileFileInfo:member(1)", "docComment": "/**\n * Register a mobile file info renderer callback.\n *\n * @param renderCallback - The callback to render file info into an element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerMobileFileInfo(renderCallback: " }, { "kind": "Content", "text": "(el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "renderCallback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "registerMobileFileInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#registerRibbonItem:member(1)", "docComment": "/**\n * Register a ribbon item button for this plugin.\n *\n * @param title - The tooltip title for the ribbon item.\n *\n * @param icon - The icon name to display.\n *\n * @param callback - The callback invoked when clicked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerRibbonItem(title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", icon: " }, { "kind": "Reference", "text": "IconName", "canonicalReference": "obsidian!IconName:type" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "() => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "icon", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": false } ], "name": "registerRibbonItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#registerStatusBarItem:member(1)", "docComment": "/**\n * Register a status bar item for this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerStatusBarItem(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "registerStatusBarItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#registerViewType:member(1)", "docComment": "/**\n * Register a view type with its creator function.\n *\n * @param type - The view type identifier.\n *\n * @param creator - The factory function to create the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerViewType(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", creator: " }, { "kind": "Reference", "text": "ViewCreator", "canonicalReference": "obsidian!ViewCreator:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "creator", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "registerViewType" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#ribbonItems:member", "docComment": "/**\n * Ribbon items registered by this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ribbonItems: " }, { "kind": "Reference", "text": "RibbonItem", "canonicalReference": "obsidian-typings!RibbonItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ribbonItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugin#saveData:member(1)", "docComment": "/**\n * Save data for this plugin.\n *\n * @param data - The data object to persist.\n *\n * @returns A promise that resolves when the data is saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveData(data: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "saveData" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#statusBarEl:member", "docComment": "/**\n * Status bar element for this plugin, or `null` if none.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusBarEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusBarEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugin#views:member", "docComment": "/**\n * View creators registered by this plugin, keyed by view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "views: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "ViewCreator", "canonicalReference": "obsidian!ViewCreator:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "views", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface", "docComment": "/**\n * Base interface for an internal plugin instance, providing lifecycle hooks and metadata.\n *\n * @typeParam InternalPlugin - The type of the internal plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InternalPluginInstance<InternalPlugin> " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/InternalPluginInstance.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "InternalPlugin", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "InternalPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPluginInstance#description:member", "docComment": "/**\n * Human-readable description of this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "description: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPluginInstance#id:member", "docComment": "/**\n * Unique identifier for this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPluginInstance#init:member(1)", "docComment": "/**\n * Initialize the plugin instance with app and plugin references.\n *\n * @param app - The app instance.\n *\n * @param plugin - The internal plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "init(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", plugin: " }, { "kind": "Content", "text": "InternalPlugin" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "plugin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "init" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPluginInstance#name:member", "docComment": "/**\n * Human-readable display name of this plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPluginInstance#onDisable:member(1)", "docComment": "/**\n * Called when the plugin is disabled.\n *\n * @param app - The app instance.\n *\n * @param plugin - The internal plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onDisable?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", plugin: " }, { "kind": "Content", "text": "InternalPlugin" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "plugin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onDisable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPluginInstance#onEnable:member(1)", "docComment": "/**\n * Called when the plugin is enabled.\n *\n * @param app - The app instance.\n *\n * @param plugin - The internal plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEnable?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", plugin: " }, { "kind": "Content", "text": "InternalPlugin" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "plugin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onEnable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPluginInstance#onUserDisable:member(1)", "docComment": "/**\n * Called when the user manually disables the plugin.\n *\n * @param app - The app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onUserDisable?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onUserDisable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPluginInstance#onUserEnable:member(1)", "docComment": "/**\n * Called when the user manually enables the plugin.\n *\n * @param app - The app instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onUserEnable?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onUserEnable" } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!InternalPluginName:var", "docComment": "/**\n * Constant mapping of internal (core) plugin name identifiers bundled with Obsidian.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "InternalPluginName: " }, { "kind": "Content", "text": "{\n readonly AudioRecorder: \"audio-recorder\";\n readonly Backlink: \"backlink\";\n readonly Bases: \"bases\";\n readonly Bookmarks: \"bookmarks\";\n readonly Canvas: \"canvas\";\n readonly CommandPalette: \"command-palette\";\n readonly DailyNotes: \"daily-notes\";\n readonly EditorStatus: \"editor-status\";\n readonly FileExplorer: \"file-explorer\";\n readonly FileRecovery: \"file-recovery\";\n readonly Footnotes: \"footnotes\";\n readonly GlobalSearch: \"global-search\";\n readonly Graph: \"graph\";\n readonly MarkdownImporter: \"markdown-importer\";\n readonly NoteComposer: \"note-composer\";\n readonly OutgoingLink: \"outgoing-link\";\n readonly Outline: \"outline\";\n readonly PagePreview: \"page-preview\";\n readonly Properties: \"properties\";\n readonly Publish: \"publish\";\n readonly RandomNote: \"random-note\";\n readonly SlashCommand: \"slash-command\";\n readonly Slides: \"slides\";\n readonly Switcher: \"switcher\";\n readonly Sync: \"sync\";\n readonly TagPane: \"tag-pane\";\n readonly Templates: \"templates\";\n readonly Webviewer: \"webviewer\";\n readonly WordCount: \"word-count\";\n readonly Workspaces: \"workspaces\";\n readonly ZkPrefixer: \"zk-prefixer\";\n}" } ], "fileUrlPath": "src/obsidian/implementations/constants/InternalPluginName.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "InternalPluginName", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!InternalPluginNameInstancesMapping:type", "docComment": "/**\n * Mapping from internal plugin name to its corresponding plugin instance type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InternalPluginNameInstancesMapping = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "InternalPluginName.AudioRecorder", "canonicalReference": "obsidian-typings!~__type#AudioRecorder" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "AudioRecorderPluginInstance", "canonicalReference": "obsidian-typings!AudioRecorderPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Backlink", "canonicalReference": "obsidian-typings!~__type#Backlink" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BacklinkPluginInstance", "canonicalReference": "obsidian-typings!BacklinkPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Bases", "canonicalReference": "obsidian-typings!~__type#Bases" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BasesPluginInstance", "canonicalReference": "obsidian-typings!BasesPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Bookmarks", "canonicalReference": "obsidian-typings!~__type#Bookmarks" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BookmarksPluginInstance", "canonicalReference": "obsidian-typings!BookmarksPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Webviewer", "canonicalReference": "obsidian-typings!~__type#Webviewer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "WebviewerPluginInstance", "canonicalReference": "obsidian-typings!WebviewerPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Canvas", "canonicalReference": "obsidian-typings!~__type#Canvas" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "CanvasPluginInstance", "canonicalReference": "obsidian-typings!CanvasPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.CommandPalette", "canonicalReference": "obsidian-typings!~__type#CommandPalette" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "CommandPalettePluginInstance", "canonicalReference": "obsidian-typings!CommandPalettePluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.DailyNotes", "canonicalReference": "obsidian-typings!~__type#DailyNotes" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "DailyNotesPluginInstance", "canonicalReference": "obsidian-typings!DailyNotesPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.EditorStatus", "canonicalReference": "obsidian-typings!~__type#EditorStatus" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "EditorStatusPluginInstance", "canonicalReference": "obsidian-typings!EditorStatusPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.FileExplorer", "canonicalReference": "obsidian-typings!~__type#FileExplorer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "FileExplorerPluginInstance", "canonicalReference": "obsidian-typings!FileExplorerPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.FileRecovery", "canonicalReference": "obsidian-typings!~__type#FileRecovery" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "FileRecoveryPluginInstance", "canonicalReference": "obsidian-typings!FileRecoveryPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Footnotes", "canonicalReference": "obsidian-typings!~__type#Footnotes" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "FootnotesPluginInstance", "canonicalReference": "obsidian-typings!FootnotesPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.GlobalSearch", "canonicalReference": "obsidian-typings!~__type#GlobalSearch" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "GlobalSearchPluginInstance", "canonicalReference": "obsidian-typings!GlobalSearchPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Graph", "canonicalReference": "obsidian-typings!~__type#Graph" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "GraphPluginInstance", "canonicalReference": "obsidian-typings!GraphPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.MarkdownImporter", "canonicalReference": "obsidian-typings!~__type#MarkdownImporter" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "MarkdownImporterPluginInstance", "canonicalReference": "obsidian-typings!MarkdownImporterPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.NoteComposer", "canonicalReference": "obsidian-typings!~__type#NoteComposer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "NoteComposerPluginInstance", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.OutgoingLink", "canonicalReference": "obsidian-typings!~__type#OutgoingLink" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "OutgoingLinkPluginInstance", "canonicalReference": "obsidian-typings!OutgoingLinkPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Outline", "canonicalReference": "obsidian-typings!~__type#Outline" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "OutlinePluginInstance", "canonicalReference": "obsidian-typings!OutlinePluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.PagePreview", "canonicalReference": "obsidian-typings!~__type#PagePreview" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "PagePreviewPluginInstance", "canonicalReference": "obsidian-typings!PagePreviewPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Properties", "canonicalReference": "obsidian-typings!~__type#Properties" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "PropertiesPluginInstance", "canonicalReference": "obsidian-typings!PropertiesPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Publish", "canonicalReference": "obsidian-typings!~__type#Publish" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "PublishPluginInstance", "canonicalReference": "obsidian-typings!PublishPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.RandomNote", "canonicalReference": "obsidian-typings!~__type#RandomNote" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "RandomNotePluginInstance", "canonicalReference": "obsidian-typings!RandomNotePluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.SlashCommand", "canonicalReference": "obsidian-typings!~__type#SlashCommand" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SlashCommandPluginInstance", "canonicalReference": "obsidian-typings!SlashCommandPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Slides", "canonicalReference": "obsidian-typings!~__type#Slides" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SlidesPluginInstance", "canonicalReference": "obsidian-typings!SlidesPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Switcher", "canonicalReference": "obsidian-typings!~__type#Switcher" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SwitcherPluginInstance", "canonicalReference": "obsidian-typings!SwitcherPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Sync", "canonicalReference": "obsidian-typings!~__type#Sync" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SyncPluginInstance", "canonicalReference": "obsidian-typings!SyncPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.TagPane", "canonicalReference": "obsidian-typings!~__type#TagPane" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "TagPanePluginInstance", "canonicalReference": "obsidian-typings!TagPanePluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Templates", "canonicalReference": "obsidian-typings!~__type#Templates" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "TemplatesPluginInstance", "canonicalReference": "obsidian-typings!TemplatesPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.WordCount", "canonicalReference": "obsidian-typings!~__type#WordCount" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "WordCountPluginInstance", "canonicalReference": "obsidian-typings!WordCountPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Workspaces", "canonicalReference": "obsidian-typings!~__type#Workspaces" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "WorkspacesPluginInstance", "canonicalReference": "obsidian-typings!WorkspacesPluginInstance:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.ZkPrefixer", "canonicalReference": "obsidian-typings!~__type#ZkPrefixer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "ZkPrefixerPluginInstance", "canonicalReference": "obsidian-typings!ZkPrefixerPluginInstance:interface" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/InternalPluginNameInstancesMapping.d.ts", "releaseTag": "Public", "name": "InternalPluginNameInstancesMapping", "typeTokenRange": { "startIndex": 1, "endIndex": 126 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!InternalPluginNamePluginsMapping:type", "docComment": "/**\n * Mapping from internal plugin name to its corresponding plugin registration type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InternalPluginNamePluginsMapping = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "InternalPluginName.AudioRecorder", "canonicalReference": "obsidian-typings!~__type#AudioRecorder" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "AudioRecorderPlugin", "canonicalReference": "obsidian-typings!AudioRecorderPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Backlink", "canonicalReference": "obsidian-typings!~__type#Backlink" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BacklinkPlugin", "canonicalReference": "obsidian-typings!BacklinkPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Bases", "canonicalReference": "obsidian-typings!~__type#Bases" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BasesPlugin", "canonicalReference": "obsidian-typings!BasesPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Bookmarks", "canonicalReference": "obsidian-typings!~__type#Bookmarks" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BookmarksPlugin", "canonicalReference": "obsidian-typings!BookmarksPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Webviewer", "canonicalReference": "obsidian-typings!~__type#Webviewer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "WebviewerPlugin", "canonicalReference": "obsidian-typings!WebviewerPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Canvas", "canonicalReference": "obsidian-typings!~__type#Canvas" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "CanvasPlugin", "canonicalReference": "obsidian-typings!CanvasPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.CommandPalette", "canonicalReference": "obsidian-typings!~__type#CommandPalette" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "CommandPalettePlugin", "canonicalReference": "obsidian-typings!CommandPalettePlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.DailyNotes", "canonicalReference": "obsidian-typings!~__type#DailyNotes" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "DailyNotesPlugin", "canonicalReference": "obsidian-typings!DailyNotesPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.EditorStatus", "canonicalReference": "obsidian-typings!~__type#EditorStatus" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "EditorStatusPlugin", "canonicalReference": "obsidian-typings!EditorStatusPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.FileExplorer", "canonicalReference": "obsidian-typings!~__type#FileExplorer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "FileExplorerPlugin", "canonicalReference": "obsidian-typings!FileExplorerPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.FileRecovery", "canonicalReference": "obsidian-typings!~__type#FileRecovery" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "FileRecoveryPlugin", "canonicalReference": "obsidian-typings!FileRecoveryPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Footnotes", "canonicalReference": "obsidian-typings!~__type#Footnotes" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "FootnotesPlugin", "canonicalReference": "obsidian-typings!FootnotesPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.GlobalSearch", "canonicalReference": "obsidian-typings!~__type#GlobalSearch" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "GlobalSearchPlugin", "canonicalReference": "obsidian-typings!GlobalSearchPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Graph", "canonicalReference": "obsidian-typings!~__type#Graph" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "GraphPlugin", "canonicalReference": "obsidian-typings!GraphPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.MarkdownImporter", "canonicalReference": "obsidian-typings!~__type#MarkdownImporter" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "MarkdownImporterPlugin", "canonicalReference": "obsidian-typings!MarkdownImporterPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.NoteComposer", "canonicalReference": "obsidian-typings!~__type#NoteComposer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "NoteComposerPlugin", "canonicalReference": "obsidian-typings!NoteComposerPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.OutgoingLink", "canonicalReference": "obsidian-typings!~__type#OutgoingLink" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "OutgoingLinkPlugin", "canonicalReference": "obsidian-typings!OutgoingLinkPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Outline", "canonicalReference": "obsidian-typings!~__type#Outline" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "OutlinePlugin", "canonicalReference": "obsidian-typings!OutlinePlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.PagePreview", "canonicalReference": "obsidian-typings!~__type#PagePreview" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "PagePreviewPlugin", "canonicalReference": "obsidian-typings!PagePreviewPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Properties", "canonicalReference": "obsidian-typings!~__type#Properties" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "PropertiesPlugin", "canonicalReference": "obsidian-typings!PropertiesPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Publish", "canonicalReference": "obsidian-typings!~__type#Publish" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "PublishPlugin", "canonicalReference": "obsidian-typings!PublishPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.RandomNote", "canonicalReference": "obsidian-typings!~__type#RandomNote" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "RandomNotePlugin", "canonicalReference": "obsidian-typings!RandomNotePlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.SlashCommand", "canonicalReference": "obsidian-typings!~__type#SlashCommand" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SlashCommandPlugin", "canonicalReference": "obsidian-typings!SlashCommandPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Slides", "canonicalReference": "obsidian-typings!~__type#Slides" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SlidesPlugin", "canonicalReference": "obsidian-typings!SlidesPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Switcher", "canonicalReference": "obsidian-typings!~__type#Switcher" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SwitcherPlugin", "canonicalReference": "obsidian-typings!SwitcherPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Sync", "canonicalReference": "obsidian-typings!~__type#Sync" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SyncPlugin", "canonicalReference": "obsidian-typings!SyncPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.TagPane", "canonicalReference": "obsidian-typings!~__type#TagPane" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "TagPanePlugin", "canonicalReference": "obsidian-typings!TagPanePlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Templates", "canonicalReference": "obsidian-typings!~__type#Templates" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "TemplatesPlugin", "canonicalReference": "obsidian-typings!TemplatesPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.WordCount", "canonicalReference": "obsidian-typings!~__type#WordCount" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "WordCountPlugin", "canonicalReference": "obsidian-typings!WordCountPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.Workspaces", "canonicalReference": "obsidian-typings!~__type#Workspaces" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "WorkspacesPlugin", "canonicalReference": "obsidian-typings!WorkspacesPlugin:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "InternalPluginName.ZkPrefixer", "canonicalReference": "obsidian-typings!~__type#ZkPrefixer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "ZkPrefixerPlugin", "canonicalReference": "obsidian-typings!ZkPrefixerPlugin:interface" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/InternalPluginNamePluginsMapping.d.ts", "releaseTag": "Public", "name": "InternalPluginNamePluginsMapping", "typeTokenRange": { "startIndex": 1, "endIndex": 126 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!InternalPluginNameType:type", "docComment": "/**\n * Union type of all internal plugin name string literals.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InternalPluginNameType = " }, { "kind": "Content", "text": "(typeof " }, { "kind": "Reference", "text": "InternalPluginName", "canonicalReference": "obsidian-typings!InternalPluginName:var" }, { "kind": "Content", "text": ")[keyof typeof " }, { "kind": "Reference", "text": "InternalPluginName", "canonicalReference": "obsidian-typings!InternalPluginName:var" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/InternalPluginNameType.d.ts", "releaseTag": "Public", "name": "InternalPluginNameType", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InternalPlugins:interface", "docComment": "/**\n * Manager for all internal (core) plugins, handling registration, enabling, and configuration.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InternalPlugins extends " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/InternalPlugins.d.ts", "releaseTag": "Public", "name": "InternalPlugins", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugins#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugins#config:member", "docComment": "/**\n * Mapping of whether an internal plugin is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "config: " }, { "kind": "Reference", "text": "InternalPluginsConfigRecord", "canonicalReference": "obsidian-typings!InternalPluginsConfigRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "config", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugins#constructor2__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getInternalPluginsConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor2__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor2__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugins#enable:member(1)", "docComment": "/**\n * Load plugin configs and enable plugins.\n *\n * @returns A promise that resolves when all plugins are enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enable(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "enable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugins#getEnabledPluginById:member(1)", "docComment": "/**\n * Get an enabled internal plugin by ID.\n *\n * @param id - ID of the plugin to get.\n *\n * @returns The plugin instance, or `null` if not enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEnabledPluginById<ID extends " }, { "kind": "Reference", "text": "InternalPluginNameType", "canonicalReference": "obsidian-typings!InternalPluginNameType:type" }, { "kind": "Content", "text": ">(id: " }, { "kind": "Content", "text": "ID" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InternalPluginNameInstancesMapping", "canonicalReference": "obsidian-typings!InternalPluginNameInstancesMapping:type" }, { "kind": "Content", "text": "[ID] | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "ID", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "getEnabledPluginById" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugins#getEnabledPlugins:member(1)", "docComment": "/**\n * Get all enabled internal plugins.\n *\n * @returns The list of enabled internal plugins.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEnabledPlugins(): " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<unknown>[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getEnabledPlugins" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugins#getPluginById:member(1)", "docComment": "/**\n * Get an internal plugin by ID.\n *\n * @param id - ID of the plugin to get.\n *\n * @returns The internal plugin, or `null` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPluginById<ID extends " }, { "kind": "Reference", "text": "InternalPluginNameType", "canonicalReference": "obsidian-typings!InternalPluginNameType:type" }, { "kind": "Content", "text": ">(id: " }, { "kind": "Content", "text": "ID" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InternalPluginNamePluginsMapping", "canonicalReference": "obsidian-typings!InternalPluginNamePluginsMapping:type" }, { "kind": "Content", "text": "[ID] | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "ID", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "getPluginById" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugins#loadPlugin:member(1)", "docComment": "/**\n * Load and register an internal plugin instance.\n *\n * @param internalPluginInstance - The plugin instance to load.\n *\n * @returns The loaded plugin instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadPlugin<Instance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ">(internalPluginInstance: " }, { "kind": "Content", "text": "Instance" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "Instance" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "internalPluginInstance", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "Instance", "constraintTokenRange": { "startIndex": 1, "endIndex": 3 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "loadPlugin" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugins#onRaw:member(1)", "docComment": "/**\n * Handle raw file change events for the config path.\n *\n * @param configPath - The path of the changed config file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRaw(configPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "configPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onRaw" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugins#plugins:member", "docComment": "/**\n * {@link obsidian#Plugin} configs for internal plugins.\n *\n * @remark\n *\n * Prefer usage of getPluginById to access a plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugins: " }, { "kind": "Reference", "text": "InternalPluginNamePluginsMapping", "canonicalReference": "obsidian-typings!InternalPluginNamePluginsMapping:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InternalPlugins#requestSaveConfig:member", "docComment": "/**\n * Request save of plugin configs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestSaveConfig: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestSaveConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!InternalPlugins#saveConfig:member(1)", "docComment": "/**\n * Save current plugin configs.\n *\n * @returns A promise that resolves when the config is saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveConfig(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveConfig" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InternalPluginsConfigRecord:interface", "docComment": "/**\n * Record mapping internal plugin names to their enabled/disabled state.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InternalPluginsConfigRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InternalPluginNameType", "canonicalReference": "obsidian-typings!InternalPluginNameType:type" }, { "kind": "Content", "text": ", boolean>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/InternalPluginsConfigRecord.d.ts", "releaseTag": "Public", "name": "InternalPluginsConfigRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!InterpolationOptions:interface", "docComment": "/**\n * Options for configuring i18next string interpolation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InterpolationOptions " } ], "fileUrlPath": "src/i18next/internals/InterpolationOptions.d.ts", "releaseTag": "Public", "name": "InterpolationOptions", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!InterpolationOptions:index(1)", "docComment": "/**\n * Additional interpolation options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InterpolationOptions#escapeValue:member", "docComment": "/**\n * Whether to escape interpolated values.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "escapeValue?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "escapeValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InterpolationOptions#prefix:member", "docComment": "/**\n * Prefix for interpolation expressions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prefix?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "prefix", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!InterpolationOptions#suffix:member", "docComment": "/**\n * Suffix for interpolation expressions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suffix?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "suffix", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!ipcRenderer:var", "docComment": "/**\n * Electron IPC renderer instance for the current renderer process.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ipcRenderer: " }, { "kind": "Reference", "text": "ElectronIpcRenderer", "canonicalReference": "obsidian-typings!ElectronIpcRenderer:interface" } ], "fileUrlPath": "src/electron/internals/vars/ipcRenderer.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "ipcRenderer", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IpcRendererEvent:interface", "docComment": "/**\n * Event object passed to IPC renderer event listeners.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IpcRendererEvent extends " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/electron/internals/IpcRendererEvent.d.ts", "releaseTag": "Public", "name": "IpcRendererEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IpcRendererEvent#ports:member", "docComment": "/**\n * A list of `MessagePort`s that were transferred with this message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ports: " }, { "kind": "Reference", "text": "MessagePort", "canonicalReference": "!MessagePort:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ports", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IpcRendererEvent#sender:member", "docComment": "/**\n * The `IpcRenderer` instance that emitted the event originally.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sender: " }, { "kind": "Reference", "text": "ElectronIpcRenderer", "canonicalReference": "obsidian-typings!ElectronIpcRenderer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IpcRendererEvent#senderId:member", "docComment": "/**\n * The `webContents.id` that sent the message. Call `event.sender.sendTo(event.senderId, ...)` to reply to the message; this only applies to messages sent from a different renderer. Messages sent directly from the main process set `senderId` to `0`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "senderId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "senderId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IPointData:interface", "docComment": "/**\n * Point data.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IPointData " } ], "fileUrlPath": "src/pixi.js/internals/IPointData.d.ts", "releaseTag": "Public", "name": "IPointData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IPointData#x:member", "docComment": "/**\n * X coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IPointData#y:member", "docComment": "/**\n * Y coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!IRenderer:interface", "docComment": "/**\n * Renderer interface.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IRenderer<VIEW extends " }, { "kind": "Reference", "text": "ICanvas", "canonicalReference": "obsidian-typings!ICanvas:interface" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "ICanvas", "canonicalReference": "obsidian-typings!ICanvas:interface" }, { "kind": "Content", "text": "> " } ], "fileUrlPath": "src/pixi.js/internals/IRenderer.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "VIEW", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "IRenderer", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IRenderer#destroy:member(1)", "docComment": "/**\n * Destroys the renderer.\n *\n * @param removeView - Whether to remove the view from the DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(removeView?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "removeView", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "destroy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IRenderer#render:member(1)", "docComment": "/**\n * Renders a display object.\n *\n * @param displayObject - The display object to render.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(displayObject: " }, { "kind": "Reference", "text": "DisplayObject", "canonicalReference": "obsidian-typings!DisplayObject:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "displayObject", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!IRenderer#resize:member(1)", "docComment": "/**\n * Resizes the renderer.\n *\n * @param desiredScreenWidth - New width.\n *\n * @param desiredScreenHeight - New height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resize(desiredScreenWidth: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", desiredScreenHeight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "desiredScreenWidth", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "desiredScreenHeight", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "resize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IRenderer#resolution:member", "docComment": "/**\n * Renderer resolution (read-only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly resolution: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "resolution", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IRenderer#screen:member", "docComment": "/**\n * Screen rectangle (read-only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly screen: " }, { "kind": "Reference", "text": "PixiRectangle", "canonicalReference": "obsidian-typings!PixiRectangle:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "screen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!IRenderer#view:member", "docComment": "/**\n * Canvas view (read-only).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly view: " }, { "kind": "Content", "text": "VIEW" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!isEmbedCache:function(1)", "docComment": "/**\n * Check if the reference is an embed cache.\n *\n * @param reference - The reference to check.\n *\n * @returns Whether the reference is an embed cache.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isEmbedCache(reference: " }, { "kind": "Reference", "text": "Reference", "canonicalReference": "obsidian!Reference:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "reference", "canonicalReference": "obsidian-typings!~reference" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "EmbedCache", "canonicalReference": "obsidian!EmbedCache:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/type-guards/isEmbedCache.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isEmbedCache" }, { "kind": "Function", "canonicalReference": "obsidian-typings!isFrontmatterLinkCache:function(1)", "docComment": "/**\n * Check if the reference is a frontmatter link cache.\n *\n * @param reference - The reference to check.\n *\n * @returns Whether the reference is a frontmatter link cache.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isFrontmatterLinkCache(reference: " }, { "kind": "Reference", "text": "Reference", "canonicalReference": "obsidian!Reference:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "reference", "canonicalReference": "obsidian-typings!~reference" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "FrontmatterLinkCache", "canonicalReference": "obsidian!FrontmatterLinkCache:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/type-guards/isFrontmatterLinkCache.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isFrontmatterLinkCache" }, { "kind": "Function", "canonicalReference": "obsidian-typings!isLinkCache:function(1)", "docComment": "/**\n * Check if the reference is a link cache.\n *\n * @param reference - The reference to check.\n *\n * @returns Whether the reference is a link cache.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isLinkCache(reference: " }, { "kind": "Reference", "text": "Reference", "canonicalReference": "obsidian!Reference:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "reference", "canonicalReference": "obsidian-typings!~reference" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "LinkCache", "canonicalReference": "obsidian!LinkCache:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/type-guards/isLinkCache.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isLinkCache" }, { "kind": "Function", "canonicalReference": "obsidian-typings!isReferenceCache:function(1)", "docComment": "/**\n * Check if the reference is a reference cache.\n *\n * @param reference - The reference to check.\n *\n * @returns Whether the reference is a reference cache.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isReferenceCache(reference: " }, { "kind": "Reference", "text": "Reference", "canonicalReference": "obsidian!Reference:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "reference", "canonicalReference": "obsidian-typings!~reference" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "ReferenceCache", "canonicalReference": "obsidian!ReferenceCache:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/type-guards/isReferenceCache.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isReferenceCache" }, { "kind": "Function", "canonicalReference": "obsidian-typings!isWordChar:function(1)", "docComment": "/**\n * Checks whether a character is a word character.\n *\n * @param ch - The character to check.\n *\n * @returns `true` if the character is a word character.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isWordChar(ch: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/isWordChar.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ch", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isWordChar" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ItemQueue:interface", "docComment": "/**\n * An async item queue that supports generator-based consumption.\n *\n * @typeParam T - The type of the items.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ItemQueue<T> " } ], "fileUrlPath": "src/obsidian/internals/collections/ItemQueue.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ItemQueue", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueue#add:member(1)", "docComment": "/**\n * Add a single item to the queue.\n *\n * @param item - Item to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add(item: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "add" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueue#addList:member(1)", "docComment": "/**\n * Add multiple items to the queue.\n *\n * @param items - Items to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addList(items: " }, { "kind": "Content", "text": "T[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "items", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addList" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueue#cancel:member(1)", "docComment": "/**\n * Cancel the queue and stop processing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cancel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueue#clear:member(1)", "docComment": "/**\n * Remove all items from the queue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueue#generator:member(1)", "docComment": "/**\n * Return an async generator that yields items as they are enqueued.\n *\n * @returns Async generator of items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "generator(): " }, { "kind": "Reference", "text": "AsyncGenerator", "canonicalReference": "!AsyncGenerator:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "generator" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ItemQueue#items:member", "docComment": "/**\n * Backing storage for the queue items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "ItemQueueItems", "canonicalReference": "obsidian-typings!ItemQueueItems:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueue#notify:member(1)", "docComment": "/**\n * Notify the queue that a new item is available for consumption.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "notify(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "notify" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ItemQueue#promise:member", "docComment": "/**\n * Promise resolvers for awaiting the next item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promise: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "PromiseWithResolvers", "canonicalReference": "obsidian-typings!PromiseWithResolvers:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "promise", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueue#remove:member(1)", "docComment": "/**\n * Remove a specific item from the queue.\n *\n * @param item - Item to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(item: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "remove" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ItemQueue#runnable:member", "docComment": "/**\n * {@link Runnable} controlling the queue's start/stop lifecycle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "runnable: " }, { "kind": "Reference", "text": "Runnable", "canonicalReference": "obsidian-typings!Runnable:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "runnable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ItemQueueItems:interface", "docComment": "/**\n * Backing storage for an {@link ItemQueue}, providing queue operations on an array.\n *\n * @typeParam T - The type of the items.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ItemQueueItems<T> " } ], "fileUrlPath": "src/obsidian/internals/collections/ItemQueueItems.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ItemQueueItems", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueueItems#clear:member(1)", "docComment": "/**\n * Remove all items from the queue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueueItems#dequeue:member(1)", "docComment": "/**\n * Remove and return the next item from the front of the queue.\n *\n * @returns The dequeued item, or `undefined` if empty.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dequeue(): " }, { "kind": "Content", "text": "T | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "dequeue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueueItems#enqueue:member(1)", "docComment": "/**\n * Add an item to the end of the queue.\n *\n * @param item - Item to enqueue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enqueue(item: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "enqueue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueueItems#enqueueArray:member(1)", "docComment": "/**\n * Add multiple items to the end of the queue.\n *\n * @param items - Items to enqueue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enqueueArray(items: " }, { "kind": "Content", "text": "T[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "items", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "enqueueArray" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueueItems#get:member(1)", "docComment": "/**\n * Get all items currently in the queue.\n *\n * @returns Array of all queued items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(): " }, { "kind": "Content", "text": "T[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueueItems#isEmpty:member(1)", "docComment": "/**\n * Whether the queue has no items.\n *\n * @returns Whether the queue is empty.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEmpty(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isEmpty" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ItemQueueItems#length:member", "docComment": "/**\n * Number of items in the queue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ItemQueueItems#offset:member", "docComment": "/**\n * Index offset for the next dequeue operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueueItems#peek:member(1)", "docComment": "/**\n * Return the next item without removing it.\n *\n * @returns The next item, or `undefined` if empty.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "peek(): " }, { "kind": "Content", "text": "T | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "peek" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ItemQueueItems#queue:member", "docComment": "/**\n * Internal array holding queued items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queue: " }, { "kind": "Content", "text": "T[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ItemQueueItems#remove:member(1)", "docComment": "/**\n * Remove a specific item from the queue.\n *\n * @param item - Item to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(item: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "remove" } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "obsidian-typings!IterMode:enum", "docComment": "/**\n * Controls tree iteration behavior.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare const enum IterMode " } ], "fileUrlPath": "src/@lezer__common/internals/IterMode.d.ts", "releaseTag": "Public", "name": "IterMode", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "obsidian-typings!IterMode.ExcludeBuffers:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "ExcludeBuffers = " }, { "kind": "Content", "text": "1" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "ExcludeBuffers" }, { "kind": "EnumMember", "canonicalReference": "obsidian-typings!IterMode.IgnoreMounts:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "IgnoreMounts = " }, { "kind": "Content", "text": "4" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "IgnoreMounts" }, { "kind": "EnumMember", "canonicalReference": "obsidian-typings!IterMode.IgnoreOverlays:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "IgnoreOverlays = " }, { "kind": "Content", "text": "8" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "IgnoreOverlays" }, { "kind": "EnumMember", "canonicalReference": "obsidian-typings!IterMode.IncludeAnonymous:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "IncludeAnonymous = " }, { "kind": "Content", "text": "2" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "IncludeAnonymous" } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ITextStyle:interface", "docComment": "/**\n * Text style interface.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ITextStyle " } ], "fileUrlPath": "src/pixi.js/internals/ITextStyle.d.ts", "releaseTag": "Public", "name": "ITextStyle", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#align:member", "docComment": "/**\n * Text alignment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "align: " }, { "kind": "Reference", "text": "TextStyleAlign", "canonicalReference": "obsidian-typings!TextStyleAlign:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "align", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#breakWords:member", "docComment": "/**\n * Whether to break words.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "breakWords: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "breakWords", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#dropShadow:member", "docComment": "/**\n * Whether to show a drop shadow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadow: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#dropShadowAlpha:member", "docComment": "/**\n * Drop shadow alpha.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowAlpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowAlpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#dropShadowAngle:member", "docComment": "/**\n * Drop shadow angle in radians.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowAngle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowAngle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#dropShadowBlur:member", "docComment": "/**\n * Drop shadow blur radius.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowBlur: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowBlur", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#dropShadowColor:member", "docComment": "/**\n * Drop shadow color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowColor: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#dropShadowDistance:member", "docComment": "/**\n * Drop shadow distance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowDistance: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowDistance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#fill:member", "docComment": "/**\n * Fill style for the text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fill: " }, { "kind": "Reference", "text": "TextStyleFill", "canonicalReference": "obsidian-typings!TextStyleFill:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fill", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#fillGradientStops:member", "docComment": "/**\n * Fill gradient stops.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fillGradientStops: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fillGradientStops", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#fillGradientType:member", "docComment": "/**\n * Fill gradient type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fillGradientType: " }, { "kind": "Reference", "text": "TEXT_GRADIENT", "canonicalReference": "obsidian-typings!TEXT_GRADIENT:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fillGradientType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#fontFamily:member", "docComment": "/**\n * Font family.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontFamily: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontFamily", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#fontSize:member", "docComment": "/**\n * Font size.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontSize: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#fontStyle:member", "docComment": "/**\n * Font style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontStyle: " }, { "kind": "Reference", "text": "TextStyleFontStyle", "canonicalReference": "obsidian-typings!TextStyleFontStyle:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#fontVariant:member", "docComment": "/**\n * Font variant.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontVariant: " }, { "kind": "Reference", "text": "TextStyleFontVariant", "canonicalReference": "obsidian-typings!TextStyleFontVariant:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontVariant", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#fontWeight:member", "docComment": "/**\n * Font weight.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontWeight: " }, { "kind": "Reference", "text": "TextStyleFontWeight", "canonicalReference": "obsidian-typings!TextStyleFontWeight:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontWeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#leading:member", "docComment": "/**\n * Leading between lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "leading: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "leading", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#letterSpacing:member", "docComment": "/**\n * Letter spacing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "letterSpacing: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "letterSpacing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#lineHeight:member", "docComment": "/**\n * Line height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineHeight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#lineJoin:member", "docComment": "/**\n * Line join style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineJoin: " }, { "kind": "Reference", "text": "TextStyleLineJoin", "canonicalReference": "obsidian-typings!TextStyleLineJoin:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineJoin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#miterLimit:member", "docComment": "/**\n * Miter limit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "miterLimit: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "miterLimit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#padding:member", "docComment": "/**\n * Padding around the text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "padding: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "padding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#stroke:member", "docComment": "/**\n * Stroke color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stroke: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stroke", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#strokeThickness:member", "docComment": "/**\n * Stroke thickness.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "strokeThickness: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "strokeThickness", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#textBaseline:member", "docComment": "/**\n * Text baseline.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textBaseline: " }, { "kind": "Reference", "text": "TextStyleTextBaseline", "canonicalReference": "obsidian-typings!TextStyleTextBaseline:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "textBaseline", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#trim:member", "docComment": "/**\n * Whether to trim whitespace.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trim: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "trim", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#whiteSpace:member", "docComment": "/**\n * White space handling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "whiteSpace: " }, { "kind": "Reference", "text": "TextStyleWhiteSpace", "canonicalReference": "obsidian-typings!TextStyleWhiteSpace:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "whiteSpace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#wordWrap:member", "docComment": "/**\n * Whether to word wrap.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wordWrap: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wordWrap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ITextStyle#wordWrapWidth:member", "docComment": "/**\n * Word wrap width.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wordWrapWidth: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wordWrapWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!JoinFunction:interface", "docComment": "/**\n * Function `Join`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface JoinFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/JoinFunction.d.ts", "releaseTag": "Public", "name": "JoinFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!KeyboardActions:interface", "docComment": "/**\n * Keyboard actions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface KeyboardActions " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/KeyboardActions.d.ts", "releaseTag": "Public", "name": "KeyboardActions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyboardActions#down:member", "docComment": "/**\n * Whether the down arrow key is currently pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "down?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "down", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyboardActions#left:member", "docComment": "/**\n * Whether the left arrow key is currently pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyboardActions#right:member", "docComment": "/**\n * Whether the right arrow key is currently pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "right?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyboardActions#shift:member", "docComment": "/**\n * Whether the shift key is currently pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shift?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "shift", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyboardActions#up:member", "docComment": "/**\n * Whether the up arrow key is currently pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "up?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "up", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyboardActions#zoomin:member", "docComment": "/**\n * Whether the zoom-in key is currently pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomin?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "zoomin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyboardActions#zoomout:member", "docComment": "/**\n * Whether the zoom-out key is currently pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomout?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "zoomout", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!keyMap:var", "docComment": "/**\n * A map of key map definitions for CodeMirror 5.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyMap: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, ((cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ") => void) | string>>" } ], "fileUrlPath": "src/codemirror/internals/vars/keyMap.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "keyMap", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!KeyScope:interface", "docComment": "/**\n * A registered keyboard shortcut interceptor within a scope.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface KeyScope " } ], "fileUrlPath": "src/obsidian/internals/KeyScope.d.ts", "releaseTag": "Public", "name": "KeyScope", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!KeyScope#func:member(1)", "docComment": "/**\n * Callback of function to execute when key is pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "func(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "func" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyScope#key:member", "docComment": "/**\n * Key to match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "key: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyScope#modifiers:member", "docComment": "/**\n * Modifiers to match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modifiers: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modifiers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!KeyScope#scope:member", "docComment": "/**\n * {@link obsidian#Scope} where the key interceptor is registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scope: " }, { "kind": "Reference", "text": "Scope", "canonicalReference": "obsidian!Scope:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!LanguageMap:type", "docComment": "/**\n * Map of language identifiers to their grammar definitions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type LanguageMap = " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/LanguageMap.d.ts", "releaseTag": "Public", "name": "LanguageMap", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LanguageMapProtocol:interface", "docComment": "/**\n * Protocol for extending and modifying Prism language definitions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LanguageMapProtocol " } ], "fileUrlPath": "src/prismjs/internals/LanguageMapProtocol.d.ts", "releaseTag": "Public", "name": "LanguageMapProtocol", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LanguageMapProtocol#extend:member(1)", "docComment": "/**\n * Creates a new grammar by extending an existing language definition.\n *\n * @param id - The language identifier to extend.\n *\n * @param redef - Token definitions to add or override.\n *\n * @returns The new grammar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extend(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", redef: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "redef", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": false } ], "name": "extend" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LanguageMapProtocol#insertBefore:member(1)", "docComment": "/**\n * Inserts tokens before an existing token in a grammar.\n *\n * @param inside - The language identifier.\n *\n * @param before - The token name to insert before.\n *\n * @param insert - The tokens to insert.\n *\n * @param root - Optional root language map.\n *\n * @returns The modified grammar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertBefore(inside: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", before: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", insert: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "GrammarValue", "canonicalReference": "obsidian-typings!GrammarValue:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", root?: " }, { "kind": "Reference", "text": "LanguageMap", "canonicalReference": "obsidian-typings!LanguageMap:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "inside", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "before", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "insert", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": false }, { "parameterName": "root", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "isOptional": true } ], "name": "insertBefore" } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!Languages:type", "docComment": "/**\n * The Prism languages registry, combining the language map with protocol methods.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Languages = " }, { "kind": "Reference", "text": "LanguageMap", "canonicalReference": "obsidian-typings!LanguageMap:type" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "LanguageMapProtocol", "canonicalReference": "obsidian-typings!LanguageMapProtocol:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/Languages.d.ts", "releaseTag": "Public", "name": "Languages", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "obsidian-typings!languages:var", "docComment": "/**\n * The Prism languages registry.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "languages: " }, { "kind": "Reference", "text": "Languages", "canonicalReference": "obsidian-typings!Languages:type" } ], "fileUrlPath": "src/prismjs/internals/vars/languages.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "languages", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LanguageState:interface", "docComment": "/**\n * Internal state for a language's parser, tracking the parse tree and context.\n *\n * @unofficial\n *\n * @see\n *\n * {@link https://github.com/codemirror/language/blob/main/src/language.ts}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LanguageState " } ], "fileUrlPath": "src/@codemirror__language/internals/LanguageState.d.ts", "releaseTag": "Public", "name": "LanguageState", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LanguageState#apply:member(1)", "docComment": "/**\n * Apply a transaction to produce an updated language state.\n *\n * @param tr - The transaction to apply.\n *\n * @returns The updated language state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "apply(tr: " }, { "kind": "Reference", "text": "Transaction", "canonicalReference": "obsidian-typings!~Transaction" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "LanguageState", "canonicalReference": "obsidian-typings!LanguageState:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tr", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "apply" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LanguageState#context:member", "docComment": "/**\n * A mutable parse state that is used to preserve work done during the lifetime of a state when moving to the next state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "context: " }, { "kind": "Reference", "text": "ParseContext", "canonicalReference": "obsidian-typings!ParseContext:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LanguageState#tree:member", "docComment": "/**\n * The current tree. Immutable, because directly accessible from the editor state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tree: " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tree", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LayoutLoaderDefinition:interface", "docComment": "/**\n * Definition for registering a Mermaid layout loader.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LayoutLoaderDefinition " } ], "fileUrlPath": "src/mermaid/internals/LayoutLoaderDefinition.d.ts", "releaseTag": "Public", "name": "LayoutLoaderDefinition", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LayoutLoaderDefinition#loader:member(1)", "docComment": "/**\n * Lazily load the layout implementation.\n *\n * @returns A promise resolving to the layout implementation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loader(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loader" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LayoutLoaderDefinition#name:member", "docComment": "/**\n * Name of the layout.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LeafEntry:interface", "docComment": "/**\n * Serialized representation of a workspace leaf or split for layout persistence.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LeafEntry " } ], "fileUrlPath": "src/obsidian/internals/LeafEntry.d.ts", "releaseTag": "Public", "name": "LeafEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LeafEntry#children:member", "docComment": "/**\n * Child leaf entries if this is a split container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "children?: " }, { "kind": "Reference", "text": "LeafEntry", "canonicalReference": "obsidian-typings!LeafEntry:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LeafEntry#direction:member", "docComment": "/**\n * Split direction if this is a split container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "direction?: " }, { "kind": "Reference", "text": "SplitDirection", "canonicalReference": "obsidian!SplitDirection:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "direction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LeafEntry#id:member", "docComment": "/**\n * Unique identifier for the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LeafEntry#state:member", "docComment": "/**\n * View state of the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state?: " }, { "kind": "Reference", "text": "ViewState", "canonicalReference": "obsidian!ViewState:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LeafEntry#type:member", "docComment": "/**\n * Type of the leaf entry (e.g. \"leaf\", \"split\", \"tabs\").\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LeafEntry#width:member", "docComment": "/**\n * Width of the leaf in pixels, if applicable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LenFunction:interface", "docComment": "/**\n * Function `Len`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LenFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/LenFunction.d.ts", "releaseTag": "Public", "name": "LenFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LessFunction:interface", "docComment": "/**\n * Function `Less`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LessFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/LessFunction.d.ts", "releaseTag": "Public", "name": "LessFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LessOrEqualFunction:interface", "docComment": "/**\n * Function `LessOrEqual`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LessOrEqualFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/LessOrEqualFunction.d.ts", "releaseTag": "Public", "name": "LessOrEqualFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!LezerTree:class", "docComment": "/**\n * A parse tree representing the syntactic structure of a document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class LezerTree " } ], "fileUrlPath": "src/@lezer__common/internals/LezerTree.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "LezerTree", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!LezerTree:constructor(1)", "docComment": "/**\n * Create a new tree node.\n *\n * @param type - The node type.\n *\n * @param children - The child trees and buffers.\n *\n * @param positions - The start positions of the children.\n *\n * @param length - The total length of content covered.\n *\n * @param props - Optional node properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(\n type: " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": ",\n children: " }, { "kind": "Content", "text": "readonly (" }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "LezerTreeBuffer", "canonicalReference": "obsidian-typings!LezerTreeBuffer:class" }, { "kind": "Content", "text": ")[]" }, { "kind": "Content", "text": ",\n positions: " }, { "kind": "Content", "text": "readonly number[]" }, { "kind": "Content", "text": ",\n length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ",\n props?: " }, { "kind": "Content", "text": "readonly [" }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<unknown> | number, unknown][]" }, { "kind": "Content", "text": "\n );" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "children", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false }, { "parameterName": "positions", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "length", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false }, { "parameterName": "props", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 16 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTree#children:member", "docComment": "/**\n * The child trees and buffers of this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly children: " }, { "kind": "Content", "text": "readonly (" }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "LezerTreeBuffer", "canonicalReference": "obsidian-typings!LezerTreeBuffer:class" }, { "kind": "Content", "text": ")[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTree#cursor:member(1)", "docComment": "/**\n * Create a cursor over this tree.\n *\n * @param mode - The iteration mode.\n *\n * @returns A tree cursor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursor(mode?: " }, { "kind": "Reference", "text": "IterMode", "canonicalReference": "obsidian-typings!IterMode:enum" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "LezerTreeCursor", "canonicalReference": "obsidian-typings!LezerTreeCursor:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "cursor" }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTree#cursorAt:member(1)", "docComment": "/**\n * Create a cursor positioned at the given position.\n *\n * @param pos - The position to start at.\n *\n * @param side - Which side of the position to prefer.\n *\n * @param mode - The iteration mode.\n *\n * @returns A tree cursor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursorAt(pos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", side?: " }, { "kind": "Content", "text": "-1 | 0 | 1" }, { "kind": "Content", "text": ", mode?: " }, { "kind": "Reference", "text": "IterMode", "canonicalReference": "obsidian-typings!IterMode:enum" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "LezerTreeCursor", "canonicalReference": "obsidian-typings!LezerTreeCursor:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "side", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "cursorAt" }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTree.empty:member", "docComment": "/**\n * An empty tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static empty: " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "empty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTree#length:member", "docComment": "/**\n * The total length of the content covered by this tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTree#positions:member", "docComment": "/**\n * The start positions of the children.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly positions: " }, { "kind": "Content", "text": "readonly number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "positions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTree#prop:member(1)", "docComment": "/**\n * Get the value of a prop for the top node type.\n *\n * @param prop - The property to look up.\n *\n * @returns The property value, or `undefined` if not set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prop<T>(prop: " }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T | undefined" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "prop", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "prop" }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTree#resolve:member(1)", "docComment": "/**\n * Resolve the node at the given position.\n *\n * @param pos - The position to resolve.\n *\n * @param side - Which side of the position to prefer.\n *\n * @returns The resolved syntax node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolve(pos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", side?: " }, { "kind": "Content", "text": "-1 | 0 | 1" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "side", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "resolve" }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTree#resolveInner:member(1)", "docComment": "/**\n * Resolve the innermost node at the given position.\n *\n * @param pos - The position to resolve.\n *\n * @param side - Which side of the position to prefer.\n *\n * @returns The resolved syntax node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolveInner(pos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", side?: " }, { "kind": "Content", "text": "-1 | 0 | 1" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "side", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "resolveInner" }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTree#topNode:member", "docComment": "/**\n * The top node of this tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get topNode(): " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "topNode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTree#type:member", "docComment": "/**\n * The type of the top node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly type: " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!LezerTreeBuffer:class", "docComment": "/**\n * A tree buffer represents a sequence of nodes in a compact flat array format.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class LezerTreeBuffer " } ], "fileUrlPath": "src/@lezer__common/internals/LezerTreeBuffer.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "LezerTreeBuffer", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeBuffer#buffer:member", "docComment": "/**\n * The flat buffer of node data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly buffer: " }, { "kind": "Reference", "text": "Uint16Array", "canonicalReference": "!Uint16Array:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "buffer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeBuffer#length:member", "docComment": "/**\n * The total length of the content covered by this buffer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeBuffer#set:member", "docComment": "/**\n * The node set that this buffer's node type ids refer to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly set: " }, { "kind": "Reference", "text": "NodeSet", "canonicalReference": "obsidian-typings!NodeSet:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "set", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!LezerTreeCursor:class", "docComment": "/**\n * A cursor for walking through the syntax tree.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class LezerTreeCursor implements " }, { "kind": "Reference", "text": "SyntaxNodeRef", "canonicalReference": "obsidian-typings!SyntaxNodeRef:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/@lezer__common/internals/LezerTreeCursor.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "LezerTreeCursor", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTreeCursor#firstChild:member(1)", "docComment": "/**\n * Move to the first child of the current node.\n *\n * @returns Whether a child was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "firstChild(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "firstChild" }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeCursor#from:member", "docComment": "/**\n * The start position of the current node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTreeCursor#lastChild:member(1)", "docComment": "/**\n * Move to the last child of the current node.\n *\n * @returns Whether a child was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastChild(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "lastChild" }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeCursor#name:member", "docComment": "/**\n * The name of the current node type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTreeCursor#next:member(1)", "docComment": "/**\n * Move to the next node in tree order.\n *\n * @param enter - Whether to enter child nodes.\n *\n * @returns Whether a next node was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "next(enter?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "enter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "next" }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTreeCursor#nextSibling:member(1)", "docComment": "/**\n * Move to the next sibling of the current node.\n *\n * @returns Whether a sibling was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nextSibling(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "nextSibling" }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeCursor#node:member", "docComment": "/**\n * The actual syntax node at the current position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly node: " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "node", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTreeCursor#parent:member(1)", "docComment": "/**\n * Move to the parent of the current node.\n *\n * @returns Whether a parent was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "parent" }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTreeCursor#prev:member(1)", "docComment": "/**\n * Move to the previous node in tree order.\n *\n * @param enter - Whether to enter child nodes.\n *\n * @returns Whether a previous node was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prev(enter?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "enter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "prev" }, { "kind": "Method", "canonicalReference": "obsidian-typings!LezerTreeCursor#prevSibling:member(1)", "docComment": "/**\n * Move to the previous sibling of the current node.\n *\n * @returns Whether a sibling was found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prevSibling(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "prevSibling" }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeCursor#to:member", "docComment": "/**\n * The end position of the current node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeCursor#tree:member", "docComment": "/**\n * The tree that the current node belongs to, if it is a top node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly tree: " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "tree", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeCursor#type:member", "docComment": "/**\n * The type of the current node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly type: " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!LezerTreeFragment:class", "docComment": "/**\n * Represents a fragment of a previously parsed tree that can be reused.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class LezerTreeFragment " } ], "fileUrlPath": "src/@lezer__common/internals/LezerTreeFragment.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "LezerTreeFragment", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeFragment#from:member", "docComment": "/**\n * The start position of this fragment in the original document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeFragment#offset:member", "docComment": "/**\n * The offset that positions in this fragment are shifted by.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeFragment#to:member", "docComment": "/**\n * The end position of this fragment in the original document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!LezerTreeFragment#tree:member", "docComment": "/**\n * The tree for this fragment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly tree: " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "tree", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LezerTreeRange:interface", "docComment": "/**\n * A range within a Lezer tree defined by start and end positions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LezerTreeRange " } ], "fileUrlPath": "src/@lezer__common/internals/LezerTreeRange.d.ts", "releaseTag": "Public", "name": "LezerTreeRange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LezerTreeRange#from:member", "docComment": "/**\n * The start position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LezerTreeRange#to:member", "docComment": "/**\n * The end position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LineDecorationSpec:interface", "docComment": "/**\n * Specification for a line decoration that styles an entire line.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LineDecorationSpec " } ], "fileUrlPath": "src/@codemirror__view/internals/LineDecorationSpec.d.ts", "releaseTag": "Public", "name": "LineDecorationSpec", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LineDecorationSpec#attributes:member", "docComment": "/**\n * HTML attributes to add to the line element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attributes?: " }, { "kind": "Reference", "text": "DecorationAttributes", "canonicalReference": "obsidian-typings!DecorationAttributes:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "attributes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LineDecorationSpec#class:member", "docComment": "/**\n * CSS class to add to the line element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "class?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "class", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LineHandle:interface", "docComment": "/**\n * Handle referencing a specific line in the editor document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LineHandle " } ], "fileUrlPath": "src/@codemirror__view/internals/LineHandle.d.ts", "releaseTag": "Public", "name": "LineHandle", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LineHandle#index:member", "docComment": "/**\n * Index of the line in the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "index", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LineHandle#row:member", "docComment": "/**\n * Row number of the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "row: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "row", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LineHandleChange:interface", "docComment": "/**\n * Describes a change applied to a line handle.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LineHandleChange " } ], "fileUrlPath": "src/@codemirror__view/internals/LineHandleChange.d.ts", "releaseTag": "Public", "name": "LineHandleChange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LineHandleChange#changes:member", "docComment": "/**\n * The change description associated with this line handle update.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changes: " }, { "kind": "Reference", "text": "ChangeDesc", "canonicalReference": "obsidian-typings!~ChangeDesc" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "changes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LinkChangeUpdate:interface", "docComment": "/**\n * Describes a single link change to apply when a file is renamed or moved.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LinkChangeUpdate " } ], "fileUrlPath": "src/obsidian/internals/link-update/LinkChangeUpdate.d.ts", "releaseTag": "Public", "name": "LinkChangeUpdate", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkChangeUpdate#change:member", "docComment": "/**\n * New link text to replace the old reference with.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "change: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "change", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkChangeUpdate#reference:member", "docComment": "/**\n * The cached reference that needs to be updated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reference: " }, { "kind": "Reference", "text": "ReferenceCache", "canonicalReference": "obsidian!ReferenceCache:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "reference", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkChangeUpdate#sourcePath:member", "docComment": "/**\n * Path of the file containing the link to update.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourcePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sourcePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LinksToFunction:interface", "docComment": "/**\n * Function `LinksTo`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LinksToFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/LinksToFunction.d.ts", "releaseTag": "Public", "name": "LinksToFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LinkSuggestion:interface", "docComment": "/**\n * @unofficial\n *\n * Suggestion for a link to a file.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LinkSuggestion extends " }, { "kind": "Reference", "text": "FileSuggestion", "canonicalReference": "obsidian-typings!FileSuggestion:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/LinkSuggestion.d.ts", "releaseTag": "Public", "name": "LinkSuggestion", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkSuggestion#alias:member", "docComment": "/**\n * Resolved link note alias.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alias?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "alias", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LinkUpdate:interface", "docComment": "/**\n * Represents a link that needs to be updated due to a file rename or move.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LinkUpdate " } ], "fileUrlPath": "src/obsidian/internals/link-update/LinkUpdate.d.ts", "releaseTag": "Public", "name": "LinkUpdate", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkUpdate#reference:member", "docComment": "/**\n * Link position in the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reference: " }, { "kind": "Reference", "text": "PositionedReference", "canonicalReference": "obsidian-typings!PositionedReference:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "reference", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkUpdate#resolvedFile:member", "docComment": "/**\n * File that was resolved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolvedFile: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resolvedFile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkUpdate#resolvedPaths:member", "docComment": "/**\n * Paths the file could have been resolved to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolvedPaths: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resolvedPaths", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkUpdate#sourceFile:member", "docComment": "/**\n * File that contains the link.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourceFile: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sourceFile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LinkUpdater:interface", "docComment": "/**\n * Handler for updating links within a specific file type when files are renamed or moved.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LinkUpdater " } ], "fileUrlPath": "src/obsidian/internals/link-update/LinkUpdater.d.ts", "releaseTag": "Public", "name": "LinkUpdater", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LinkUpdater#applyUpdates:member(1)", "docComment": "/**\n * Apply a batch of link change updates to the given file.\n *\n * @param file - File to update.\n *\n * @param updates - Link change updates to apply.\n *\n * @returns A promise that resolves when the updates have been applied.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applyUpdates(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", updates: " }, { "kind": "Reference", "text": "LinkChangeUpdate", "canonicalReference": "obsidian-typings!LinkChangeUpdate:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "updates", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "applyUpdates" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LinkUpdater#iterateReferences:member(1)", "docComment": "/**\n * Iterate over all references managed by this updater.\n *\n * @param callback - Callback invoked for each reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iterateReferences(callback: " }, { "kind": "Content", "text": "(path: string, reference: " }, { "kind": "Reference", "text": "ReferenceCache", "canonicalReference": "obsidian!ReferenceCache:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "iterateReferences" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LinkUpdater#iterateReferencesForFile:member(1)", "docComment": "/**\n * Iterate over all references managed by this updater for a specific file.\n *\n * @param path - Path of the file to iterate references for.\n *\n * @param callback - Callback invoked for each reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iterateReferencesForFile(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(reference: " }, { "kind": "Reference", "text": "ReferenceCache", "canonicalReference": "obsidian!ReferenceCache:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "iterateReferencesForFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LinkUpdater#renameSubpath:member(1)", "docComment": "/**\n * Rename a subpath reference (e.g. heading or block) within a file.\n *\n * @param file - File containing the subpath.\n *\n * @param oldSubpath - Previous subpath.\n *\n * @param newSubpath - New subpath.\n *\n * @returns A promise that resolves when the subpath has been renamed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renameSubpath(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", oldSubpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", newSubpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "oldSubpath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "newSubpath", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "renameSubpath" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LinkUpdaters:interface", "docComment": "/**\n * Record of link updaters keyed by file type, used to update links when files are renamed or moved.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LinkUpdaters extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "LinkUpdater", "canonicalReference": "obsidian-typings!LinkUpdater:interface" }, { "kind": "Content", "text": " | undefined>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/link-update/LinkUpdaters.d.ts", "releaseTag": "Public", "name": "LinkUpdaters", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LinkUpdaters#canvas:member", "docComment": "/**\n * Link updater for canvas files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas?: " }, { "kind": "Reference", "text": "CanvasLinkUpdater", "canonicalReference": "obsidian-typings!CanvasLinkUpdater:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!LinkUpdatesHandler:type", "docComment": "/**\n * Callback that processes a batch of link updates when files are renamed or moved.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type LinkUpdatesHandler = " }, { "kind": "Content", "text": "(linkUpdates: " }, { "kind": "Reference", "text": "LinkUpdate", "canonicalReference": "obsidian-typings!LinkUpdate:interface" }, { "kind": "Content", "text": "[]) => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/link-update/LinkUpdatesHandler.d.ts", "releaseTag": "Public", "name": "LinkUpdatesHandler", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!LiteralStringUnion:type", "docComment": "/**\n * A string-literal type `T` that still accepts any other `string`.\n *\n * The `& Record<never, never>` on the `string` arm keeps the literal members of `T` visible for editor autocomplete (they are not collapsed into `string`), while the whole union stays assignable-compatible with `string`. This lets a member typed as `LiteralStringUnion<T>` be overridden by a subclass that returns a plain `string` — a bare `T` (e.g. `'markdown'`) could not, since `string` is not assignable to a narrower literal.\n *\n * @typeParam T - The string-literal type to keep visible.\n *\n * @example\n * ```ts\n * // Accepts `'markdown'` (with autocomplete) or any other string:\n * type ViewTypeName = LiteralStringUnion<'markdown'>;\n * ```\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type LiteralStringUnion<T extends " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<never, never> & string) | T" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/LiteralStringUnion.d.ts", "releaseTag": "Public", "name": "LiteralStringUnion", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "obsidian-typings!loadLanguages:var", "docComment": "/**\n * Loads additional languages.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadLanguages: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['loadLanguages']" } ], "fileUrlPath": "src/i18next/internals/functions/loadLanguages.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "loadLanguages", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Function", "canonicalReference": "obsidian-typings!loadMermaid:function(1)", "docComment": "/**\n * Load Mermaid and return a promise to the global mermaid object. Can also use `window.mermaid` after this promise resolves to get the same reference.\n *\n * @returns A promise that resolves to the global `window.mermaid` object.\n *\n * @unofficial\n *\n * @see\n *\n * {@link https://mermaid.js.org/ | Official Mermaid documentation}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function loadMermaid(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Mermaid", "canonicalReference": "obsidian-typings!Mermaid:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/functions/loadMermaid.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadMermaid" }, { "kind": "Variable", "canonicalReference": "obsidian-typings!loadNamespaces:var", "docComment": "/**\n * Loads additional namespaces.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadNamespaces: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['loadNamespaces']" } ], "fileUrlPath": "src/i18next/internals/functions/loadNamespaces.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "loadNamespaces", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Function", "canonicalReference": "obsidian-typings!loadPdfJs:function(1)", "docComment": "/**\n * Load PDF.js and return a promise to the global pdfjsLib object. Can also use `window.pdfjsLib` after this promise resolves to get the same reference.\n *\n * @returns A promise that resolves to the global `window.pdfjsLib` object.\n *\n * @unofficial\n *\n * @see\n *\n * {@link https://mozilla.github.io/pdf.js/ | Official PDF.js documentation}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function loadPdfJs(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PdfJsModule", "canonicalReference": "obsidian-typings!PdfJsModule:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/functions/loadPdfJs.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadPdfJs" }, { "kind": "Function", "canonicalReference": "obsidian-typings!loadPrism:function(1)", "docComment": "/**\n * Load Prism.js and return a promise to the global Prism object. Can also use `window.Prism` after this promise resolves to get the same reference.\n *\n * @returns A promise that resolves to the global `window.Prism` object.\n *\n * @unofficial\n *\n * @see\n *\n * {@link https://prismjs.com/ | Official Prism documentation}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function loadPrism(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismModule", "canonicalReference": "obsidian-typings!PrismModule:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/functions/loadPrism.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadPrism" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LoadProgress:interface", "docComment": "/**\n * Represents a loading progress indicator.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LoadProgress " } ], "fileUrlPath": "src/obsidian/internals/LoadProgress.d.ts", "releaseTag": "Public", "name": "LoadProgress", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!loadResources:var", "docComment": "/**\n * Loads resources using the configured backend.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadResources: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['loadResources']" } ], "fileUrlPath": "src/i18next/internals/functions/loadResources.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "loadResources", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!LocalGraphView:interface", "docComment": "/**\n * Obsidian view for a local graph.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LocalGraphView extends " }, { "kind": "Reference", "text": "InfoFileView", "canonicalReference": "obsidian-typings!InfoFileView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/LocalGraphView.d.ts", "releaseTag": "Public", "name": "LocalGraphView", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LocalGraphView#engine:member", "docComment": "/**\n * Graph engine powering the local graph simulation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "engine: " }, { "kind": "Reference", "text": "GraphEngine", "canonicalReference": "obsidian-typings!GraphEngine:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "engine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LocalGraphView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The local graph view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.LocalGraph", "canonicalReference": "obsidian-typings!~__type#LocalGraph:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LocalGraphView#onFileChanged:member(1)", "docComment": "/**\n * Requests a update if the changed file is the opened file.\n *\n * @param file - The changed file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileChanged(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileChanged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LocalGraphView#onOptionsChange:member(1)", "docComment": "/**\n * Updates the options from the plugin when changed in view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onOptionsChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onOptionsChange" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!LocalGraphView#renderer:member", "docComment": "/**\n * Renderer responsible for drawing the local graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderer: " }, { "kind": "Reference", "text": "GraphRenderer", "canonicalReference": "obsidian-typings!GraphRenderer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!LocalGraphView#update:member(1)", "docComment": "/**\n * Renders the graph.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Localization:interface", "docComment": "/**\n * Nested dictionary of localization strings for internationalization.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Localization " } ], "fileUrlPath": "src/obsidian/internals/Localization.d.ts", "releaseTag": "Public", "name": "Localization", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!Localization:index(1)", "docComment": "/**\n * Localized string value, or nested localization group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "Localization", "canonicalReference": "obsidian-typings!Localization:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!manual:var", "docComment": "/**\n * Whether Prism should skip automatic highlighting on page load.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "manual: " }, { "kind": "Content", "text": "boolean | undefined" } ], "fileUrlPath": "src/prismjs/internals/vars/manual.d.ts", "isReadonly": false, "releaseTag": "Public", "name": "manual", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Enum", "canonicalReference": "obsidian-typings!MapMode:enum", "docComment": "/**\n * Determines how position mapping works for a change.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum MapMode " } ], "fileUrlPath": "src/@codemirror__state/internals/MapMode.d.ts", "releaseTag": "Public", "name": "MapMode", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "obsidian-typings!MapMode.Simple:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Simple = " }, { "kind": "Content", "text": "0" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Simple" }, { "kind": "EnumMember", "canonicalReference": "obsidian-typings!MapMode.TrackAfter:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "TrackAfter = " }, { "kind": "Content", "text": "3" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TrackAfter" }, { "kind": "EnumMember", "canonicalReference": "obsidian-typings!MapMode.TrackBefore:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "TrackBefore = " }, { "kind": "Content", "text": "2" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TrackBefore" }, { "kind": "EnumMember", "canonicalReference": "obsidian-typings!MapMode.TrackDel:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "TrackDel = " }, { "kind": "Content", "text": "1" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TrackDel" } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MapOfSets:interface", "docComment": "/**\n * A map where each key is associated with a set of values.\n *\n * @typeParam Key - The key type.\n *\n * @typeParam Value - The value type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MapOfSets<Key, Value> " } ], "fileUrlPath": "src/obsidian/internals/collections/MapOfSets.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Key", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Value", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "MapOfSets", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MapOfSets#add:member(1)", "docComment": "/**\n * Add a value to the set associated with the given key.\n *\n * @param key - The key.\n *\n * @param value - The value to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add(key: " }, { "kind": "Content", "text": "Key" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "add" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MapOfSets#data:member", "docComment": "/**\n * Internal map storing key-to-set mappings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<Key, " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<Value>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MapOfSets#delete:member(1)", "docComment": "/**\n * Remove a value from the set associated with the given key.\n *\n * @param key - The key.\n *\n * @param value - The value to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "delete(key: " }, { "kind": "Content", "text": "Key" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "delete" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MapOfSets#get:member(1)", "docComment": "/**\n * Get the set of values for the given key, or `null` if not found.\n *\n * @param key - The key.\n *\n * @returns Set of values, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(key: " }, { "kind": "Content", "text": "Key" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<Value>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MapOfSets#getArray:member(1)", "docComment": "/**\n * Get the values for the given key as an array.\n *\n * @param key - The key.\n *\n * @returns Array of values.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getArray(key: " }, { "kind": "Content", "text": "Key" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "Value[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getArray" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkDecorationSpec:interface", "docComment": "/**\n * Specification for a mark decoration that styles a range of text.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkDecorationSpec " } ], "fileUrlPath": "src/@codemirror__view/internals/MarkDecorationSpec.d.ts", "releaseTag": "Public", "name": "MarkDecorationSpec", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkDecorationSpec#attributes:member", "docComment": "/**\n * HTML attributes to add to the wrapping element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attributes?: " }, { "kind": "Reference", "text": "DecorationAttributes", "canonicalReference": "obsidian-typings!DecorationAttributes:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "attributes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkDecorationSpec#class:member", "docComment": "/**\n * CSS class to add to the wrapping element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "class?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "class", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkDecorationSpec#inclusive:member", "docComment": "/**\n * Whether both sides of the decoration are inclusive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inclusive?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inclusive", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkDecorationSpec#inclusiveEnd:member", "docComment": "/**\n * Whether the end of the decoration is inclusive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inclusiveEnd?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inclusiveEnd", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkDecorationSpec#inclusiveStart:member", "docComment": "/**\n * Whether the start of the decoration is inclusive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inclusiveStart?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inclusiveStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkDecorationSpec#tagName:member", "docComment": "/**\n * The HTML tag to wrap the text in.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tagName?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tagName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkdownBaseView:interface", "docComment": "/**\n * Base interface for markdown editor views, providing CodeMirror integration and editing capabilities.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkdownBaseView extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/MarkdownBaseView.d.ts", "releaseTag": "Public", "name": "MarkdownBaseView", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!MarkdownBaseView#activeCM:member", "docComment": "/**\n * Currently active CM instance (table cell CM or main CM).\n *\n * @returns The active CodeMirror editor view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get activeCM(): " }, { "kind": "Reference", "text": "EditorView", "canonicalReference": "obsidian-typings!~EditorView" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "activeCM", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#applyFoldInfo:member(1)", "docComment": "/**\n * Apply fold history to editor.\n *\n * @param info - Fold information to apply.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applyFoldInfo(info: " }, { "kind": "Reference", "text": "FoldInfo", "canonicalReference": "obsidian-typings!FoldInfo:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "applyFoldInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#buildLocalExtensions:member(1)", "docComment": "/**\n * Constructs local (always active) extensions for the editor.\n *\n * @returns Array of CodeMirror extensions.\n *\n * @remark\n *\n * Creates extensions for handling dom events, editor info state fields, update listener, suggestions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buildLocalExtensions(): " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "buildLocalExtensions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#cleanupLivePreview:member", "docComment": "/**\n * Callback to clear all elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cleanupLivePreview: " }, { "kind": "Content", "text": "(() => void) | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cleanupLivePreview", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#clear:member(1)", "docComment": "/**\n * Cleanup live preview, remove and then re-add all editor extensions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#clipboardManager:member", "docComment": "/**\n * Manager that handles pasting text, html and images into the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clipboardManager: " }, { "kind": "Reference", "text": "ClipboardManager", "canonicalReference": "obsidian-typings!ClipboardManager:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clipboardManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#cm:member", "docComment": "/**\n * Codemirror editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cm: " }, { "kind": "Reference", "text": "EditorView", "canonicalReference": "obsidian-typings!~EditorView" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cm", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#cmInit:member", "docComment": "/**\n * Whether CodeMirror is initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cmInit: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cmInit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#containerEl:member", "docComment": "/**\n * Container element of the editor view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#cursorPopupEl:member", "docComment": "/**\n * Popup element for internal link.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursorPopupEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cursorPopupEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#destroy:member(1)", "docComment": "/**\n * Clean up live preview, remove all extensions, destroy editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#destroyTableCell:member(1)", "docComment": "/**\n * Removes specified tablecell.\n *\n * @param cell - Table cell editor to destroy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroyTableCell(cell?: " }, { "kind": "Reference", "text": "TableCellEditor", "canonicalReference": "obsidian-typings!TableCellEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cell", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "destroyTableCell" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#editor:member", "docComment": "/**\n * Obsidian editor instance.\n *\n * @remark\n *\n * Handles formatting, table creation, highlight adding, etc.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editor?: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "editor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#editorEl:member", "docComment": "/**\n * Element in which the CodeMirror editor resides.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editorEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "editorEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#editorSuggest:member", "docComment": "/**\n * Editor suggester for autocompleting files, links, aliases, etc.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editorSuggest: " }, { "kind": "Reference", "text": "EditorSuggests", "canonicalReference": "obsidian-typings!EditorSuggests:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "editorSuggest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#editTableCell:member(1)", "docComment": "/**\n * Edit a specified table cell, creating a table cell editor.\n *\n * @param cell - Table editor owning the cell.\n *\n * @param newCell - Table cell to edit.\n *\n * @returns The created table cell editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editTableCell(cell: " }, { "kind": "Reference", "text": "TableEditor", "canonicalReference": "obsidian-typings!TableEditor:interface" }, { "kind": "Content", "text": ", newCell: " }, { "kind": "Reference", "text": "TableCell", "canonicalReference": "obsidian-typings!TableCell:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TableCellEditor", "canonicalReference": "obsidian-typings!TableCellEditor:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cell", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newCell", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "editTableCell" }, { "kind": "Property", "canonicalReference": "obsidian-typings!MarkdownBaseView#file:member", "docComment": "/**\n * Returns attached file of the owner instance.\n *\n * @returns The attached file, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get file(): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#get:member(1)", "docComment": "/**\n * Get the current editor document as a string.\n *\n * @returns The editor document content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#getDynamicExtensions:member(1)", "docComment": "/**\n * Constructs extensions for the editor based on user settings.\n *\n * @returns Array of dynamic CodeMirror extensions.\n *\n * @remark\n *\n * Creates extension for tab size, RTL rendering, spellchecking, pairing markdown syntax, live preview and vim.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDynamicExtensions(): " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDynamicExtensions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#getFoldInfo:member(1)", "docComment": "/**\n * Get the current folds of the editor.\n *\n * @returns Current fold information, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFoldInfo(): " }, { "kind": "Reference", "text": "FoldInfo", "canonicalReference": "obsidian-typings!FoldInfo:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFoldInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#getLocalExtensions:member(1)", "docComment": "/**\n * Builds all local extensions and assigns to `this.localExtensions`.\n *\n * @returns The local extensions.\n *\n * @remark\n *\n * Will build extensions if they were not already built.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLocalExtensions(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLocalExtensions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#livePreviewPlugin:member", "docComment": "/**\n * The CodeMirror plugins that handle the rendering of, and interaction with Obsidian's Markdown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "livePreviewPlugin: " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "livePreviewPlugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#localExtensions:member", "docComment": "/**\n * Local (always active) extensions for the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "localExtensions: " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "localExtensions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#onContextMenu:member(1)", "docComment": "/**\n * Creates menu on right mouse click.\n *\n * @param event - The pointer event.\n *\n * @param x - Whether the context menu was triggered by keyboard.\n *\n * @returns A promise that resolves when the context menu is handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onContextMenu(event: " }, { "kind": "Reference", "text": "PointerEvent", "canonicalReference": "!PointerEvent:interface" }, { "kind": "Content", "text": ", x: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onContextMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#onEditorClick:member(1)", "docComment": "/**\n * Execute click functionality on token on mouse click.\n *\n * @param event - The mouse event.\n *\n * @param element - The clicked element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEditorClick(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", element?: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "onEditorClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#onEditorDragStart:member(1)", "docComment": "/**\n * Execute drag functionality on drag start.\n *\n * @param event - The drag event.\n *\n * @remark\n *\n * Interfaces with dragManager.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEditorDragStart(event: " }, { "kind": "Reference", "text": "DragEvent", "canonicalReference": "!DragEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onEditorDragStart" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#onEditorLinkMouseover:member(1)", "docComment": "/**\n * Execute hover functionality on mouse over event.\n *\n * @param event - The mouse event.\n *\n * @param target - The hovered element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEditorLinkMouseover(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", target: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onEditorLinkMouseover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#onMenu:member(1)", "docComment": "/**\n * Execute context menu functionality on right mouse click.\n *\n * @deprecated\n *\n * Use {@link MarkdownBaseView.onContextMenu} instead.\n *\n * @param event - The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMenu(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#onResize:member(1)", "docComment": "/**\n * Reposition suggest and scroll position on resize.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#onUpdate:member(1)", "docComment": "/**\n * Execute functionality on CM editor state update.\n *\n * @param update - The CodeMirror view update.\n *\n * @param changed - Whether the document content changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onUpdate(update: " }, { "kind": "Reference", "text": "ViewUpdate", "canonicalReference": "@codemirror/view!ViewUpdate:class" }, { "kind": "Content", "text": ", changed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "update", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "changed", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onUpdate" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#owner:member", "docComment": "/**\n * Controller of the editor view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "owner: " }, { "kind": "Reference", "text": "MarkdownFileInfo", "canonicalReference": "obsidian!MarkdownFileInfo:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "owner", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Property", "canonicalReference": "obsidian-typings!MarkdownBaseView#path:member", "docComment": "/**\n * Returns path of the attached file.\n *\n * @returns The file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get path(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#reinit:member(1)", "docComment": "/**\n * Reinitialize the editor inside new container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reinit(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "reinit" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#reparent:member(1)", "docComment": "/**\n * Move the editor into the new container.\n *\n * @param newContainer - New container element for the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reparent(newContainer: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "newContainer", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "reparent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#resetSyntaxHighlighting:member(1)", "docComment": "/**\n * Bodge to reset the syntax highlighting.\n *\n * @remark\n *\n * Uses single-character replacement transaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resetSyntaxHighlighting(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "resetSyntaxHighlighting" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#saveHistory:member(1)", "docComment": "/**\n * Save history of file and data (for caching, for faster reopening of same file in editor).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveHistory(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveHistory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#set:member(1)", "docComment": "/**\n * Set the state of the editor.\n *\n * @param data - Document content to set.\n *\n * @param clear - Whether to clear existing state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "set(data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", clear: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "clear", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "set" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#sourceMode:member", "docComment": "/**\n * Whether live preview rendering is disabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourceMode: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sourceMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#tableCell:member", "docComment": "/**\n * Reference to editor attached to table cell, if any.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tableCell: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TableCellEditor", "canonicalReference": "obsidian-typings!TableCellEditor:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tableCell", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#toggleFoldFrontmatter:member(1)", "docComment": "/**\n * Enables/disables frontmatter folding.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleFoldFrontmatter(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleFoldFrontmatter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#toggleSource:member(1)", "docComment": "/**\n * Toggle source mode for editor and dispatch effect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleSource(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleSource" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#triggerClickableToken:member(1)", "docComment": "/**\n * Execute functionality of token (open external link, open internal link in leaf, ...).\n *\n * @param token - The clickable token.\n *\n * @param newLeaf - Whether to open in a new leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "triggerClickableToken(token: " }, { "kind": "Reference", "text": "Token", "canonicalReference": "obsidian-typings!Token:interface" }, { "kind": "Content", "text": ", newLeaf: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "token", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newLeaf", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "triggerClickableToken" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#updateEvent:member(1)", "docComment": "/**\n * Callback for onUpdate functionality added as an extension.\n *\n * @returns A callback function that handles view updates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateEvent(): " }, { "kind": "Content", "text": "(update: " }, { "kind": "Reference", "text": "ViewUpdate", "canonicalReference": "@codemirror/view!ViewUpdate:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateEvent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#updateLinkPopup:member(1)", "docComment": "/**\n * In mobile, creates a popover link on clickable token, if exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateLinkPopup(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateLinkPopup" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownBaseView#updateOptions:member(1)", "docComment": "/**\n * Reconfigure/re-add all the dynamic extensions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateOptions(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateOptions" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkdownEditViewEphemeralState:interface", "docComment": "/**\n * Ephemeral state for the markdown edit view, storing cursor position.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkdownEditViewEphemeralState " } ], "fileUrlPath": "src/obsidian/internals/MarkdownEditViewEphemeralState.d.ts", "releaseTag": "Public", "name": "MarkdownEditViewEphemeralState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownEditViewEphemeralState#cursor:member", "docComment": "/**\n * Current cursor selection range in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursor: " }, { "kind": "Reference", "text": "EditorRange", "canonicalReference": "obsidian!EditorRange:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cursor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkdownImporterPlugin:interface", "docComment": "/**\n * Internal plugin registration for the Markdown importer feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkdownImporterPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MarkdownImporterPluginInstance", "canonicalReference": "obsidian-typings!MarkdownImporterPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/markdown-importer/MarkdownImporterPlugin.d.ts", "releaseTag": "Public", "name": "MarkdownImporterPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkdownImporterPluginInstance:interface", "docComment": "/**\n * Plugin instance for the Markdown importer, providing conversion from other formats to Markdown.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkdownImporterPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MarkdownImporterPlugin", "canonicalReference": "obsidian-typings!MarkdownImporterPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/markdown-importer/MarkdownImporterPluginInstance.d.ts", "releaseTag": "Public", "name": "MarkdownImporterPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownImporterPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView:interface", "docComment": "/**\n * Extended markdown editor view with scrolling, search, and CSS class management.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkdownScrollableEditView extends " }, { "kind": "Reference", "text": "MarkdownBaseView", "canonicalReference": "obsidian-typings!MarkdownBaseView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/MarkdownScrollableEditView.d.ts", "releaseTag": "Public", "name": "MarkdownScrollableEditView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#applyScroll:member(1)", "docComment": "/**\n * Set the scroll count of the editor scrollbar.\n *\n * @param scroll - Scroll position to apply.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applyScroll(scroll: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scroll", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "applyScroll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#buildLocalExtensions:member(1)", "docComment": "/**\n * Constructs local (always active) extensions for the editor.\n *\n * @returns Array of CodeMirror extensions.\n *\n * @remark\n *\n * Creates extensions for list indentation, tab indentations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buildLocalExtensions(): " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "buildLocalExtensions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#cssClasses:member", "docComment": "/**\n * List of CSS classes applied to the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cssClasses: " }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cssClasses", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#focus:member(1)", "docComment": "/**\n * Focus the editor (and for mobile: render keyboard).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#getDynamicExtensions:member(1)", "docComment": "/**\n * Constructs extensions for the editor based on user settings.\n *\n * @returns Array of dynamic CodeMirror extensions.\n *\n * @remark\n *\n * Creates toggleable extensions for showing line numbers, indentation guides,. folding, brackets pairing and properties rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDynamicExtensions(): " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDynamicExtensions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#getScroll:member(1)", "docComment": "/**\n * Get the current scroll count of the editor scrollbar.\n *\n * @returns Current scroll position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getScroll(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getScroll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#handleScroll:member(1)", "docComment": "/**\n * Invokes onMarkdownScroll on scroll.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleScroll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "handleScroll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#hide:member(1)", "docComment": "/**\n * Hides the editor (sets display: none).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hide(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hide" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#isScrolling:member", "docComment": "/**\n * Whether the editor is currently scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isScrolling: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isScrolling", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#onCssChange:member(1)", "docComment": "/**\n * Clear editor cache and refreshes editor on app css change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCssChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onCssChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#onResize:member(1)", "docComment": "/**\n * Update editor size and bottom padding on resize.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#onScroll:member(1)", "docComment": "/**\n * Update editor suggest position and invokes handleScroll on scroll.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onScroll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onScroll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#onUpdate:member(1)", "docComment": "/**\n * Execute functionality on CM editor state update.\n *\n * @param update - The CodeMirror view update.\n *\n * @param changed - Whether the document content changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onUpdate(update: " }, { "kind": "Reference", "text": "ViewUpdate", "canonicalReference": "@codemirror/view!ViewUpdate:class" }, { "kind": "Content", "text": ", changed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "update", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "changed", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onUpdate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#onViewClick:member(1)", "docComment": "/**\n * Close editor suggest and removes highlights on click.\n *\n * @param event - The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onViewClick(event?: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "onViewClick" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#scope:member", "docComment": "/**\n * {@link obsidian#Scope} for the search component, if exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scope: " }, { "kind": "Reference", "text": "Scope", "canonicalReference": "obsidian!Scope:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#search:member", "docComment": "/**\n * Search component for the editor, provides highlight and search functionality.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "search: " }, { "kind": "Reference", "text": "EditorSearchComponent", "canonicalReference": "obsidian-typings!EditorSearchComponent:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "search", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#setCssClass:member(1)", "docComment": "/**\n * Add classes to the editor, functions as a toggle.\n *\n * @param classes - CSS classes to apply.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCssClass(classes: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "classes", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setCssClass" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#show:member(1)", "docComment": "/**\n * Reveal the editor (sets display: block).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "show(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "show" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#showSearch:member(1)", "docComment": "/**\n * Reveal the search (and replace) component.\n *\n * @param replace - Whether to show the replace input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSearch(replace: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replace", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showSearch" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#sizerEl:member", "docComment": "/**\n * Container for the editor, handles editor size.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sizerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sizerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MarkdownScrollableEditView#updateBottomPadding:member(1)", "docComment": "/**\n * Update the bottom padding of the CodeMirror contentdom.\n *\n * @param height - Height of the bottom padding in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateBottomPadding(height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateBottomPadding" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkdownViewEphemeralState:interface", "docComment": "/**\n * Ephemeral state for a markdown view, storing scroll position.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkdownViewEphemeralState extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/MarkdownViewEphemeralState.d.ts", "releaseTag": "Public", "name": "MarkdownViewEphemeralState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownViewEphemeralState#scroll:member", "docComment": "/**\n * Scroll position in the view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scroll: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkdownViewModes:interface", "docComment": "/**\n * Available view modes for a markdown view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkdownViewModes " } ], "fileUrlPath": "src/obsidian/internals/MarkdownViewModes.d.ts", "releaseTag": "Public", "name": "MarkdownViewModes", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownViewModes#preview:member", "docComment": "/**\n * Reading/preview mode renderer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preview: " }, { "kind": "Reference", "text": "MarkdownPreviewView", "canonicalReference": "obsidian!MarkdownPreviewView:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "preview", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownViewModes#source:member", "docComment": "/**\n * Source/edit mode renderer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "source: " }, { "kind": "Reference", "text": "MarkdownEditView", "canonicalReference": "obsidian!MarkdownEditView:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MarkdownViewSourceMode:interface", "docComment": "/**\n * Source mode configuration for a markdown view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MarkdownViewSourceMode " } ], "fileUrlPath": "src/obsidian/internals/MarkdownViewSourceMode.d.ts", "releaseTag": "Public", "name": "MarkdownViewSourceMode", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MarkdownViewSourceMode#cmEditor:member", "docComment": "/**\n * The CodeMirror editor instance used in source mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cmEditor: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cmEditor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MatchingBracket:interface", "docComment": "/**\n * Result of a matching bracket search.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MatchingBracket " } ], "fileUrlPath": "src/@codemirror__view/internals/MatchingBracket.d.ts", "releaseTag": "Public", "name": "MatchingBracket", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MatchingBracket#to:member", "docComment": "/**\n * Position of the matching bracket, if found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to?: " }, { "kind": "Reference", "text": "EditorPosition", "canonicalReference": "obsidian!EditorPosition:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MathJaxEx:interface", "docComment": "/**\n * MathJax library interface for rendering LaTeX math expressions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MathJaxEx " } ], "fileUrlPath": "src/mathjax/internals/MathJaxEx.d.ts", "releaseTag": "Public", "name": "MathJaxEx", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#chtmlStylesheet:member(1)", "docComment": "/**\n * Get the CHTML stylesheet element for MathJax-rendered content.\n *\n * @returns The stylesheet element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "chtmlStylesheet(): " }, { "kind": "Reference", "text": "HTMLStyleElement", "canonicalReference": "!HTMLStyleElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "chtmlStylesheet" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MathJaxEx#config:member", "docComment": "/**\n * MathJax configuration object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "config: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "config", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#getMetricsFor:member(1)", "docComment": "/**\n * Get font metrics for a given DOM node, used for scaling math output.\n *\n * @param node - DOM node to get metrics for.\n *\n * @param display - Whether display mode is enabled.\n *\n * @returns Font metrics for the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMetricsFor(node: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", display?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExtendedMetrics", "canonicalReference": "obsidian-typings!ExtendedMetrics:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "display", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "getMetricsFor" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MathJaxEx#loader:member", "docComment": "/**\n * MathJax component loader.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loader: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "loader", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MathJaxEx#options:member", "docComment": "/**\n * MathJax runtime options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#tex2chtml:member(1)", "docComment": "/**\n * Convert a TeX string to a CHTML (HTML) element synchronously.\n *\n * @param math - TeX string to convert.\n *\n * @param options - Optional rendering options.\n *\n * @returns The rendered HTML element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tex2chtml(math: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "math", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": true } ], "name": "tex2chtml" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#tex2chtmlPromise:member(1)", "docComment": "/**\n * Convert a TeX string to a CHTML (HTML) element asynchronously.\n *\n * @param math - TeX string to convert.\n *\n * @param options - Optional rendering options.\n *\n * @returns The rendered HTML element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tex2chtmlPromise(math: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "math", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": true } ], "name": "tex2chtmlPromise" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#tex2mml:member(1)", "docComment": "/**\n * Convert a TeX string to MathML markup synchronously.\n *\n * @param math - TeX string to convert.\n *\n * @param options - Optional rendering options.\n *\n * @returns The MathML markup string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tex2mml(math: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "math", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": true } ], "name": "tex2mml" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#tex2mmlPromise:member(1)", "docComment": "/**\n * Convert a TeX string to MathML markup asynchronously.\n *\n * @param math - TeX string to convert.\n *\n * @param options - Optional rendering options.\n *\n * @returns The MathML markup string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tex2mmlPromise(math: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "math", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": true } ], "name": "tex2mmlPromise" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#texReset:member(1)", "docComment": "/**\n * Reset the TeX input jax, clearing equation numbering and labels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "texReset(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "texReset" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#typeset:member(1)", "docComment": "/**\n * Typeset math expressions in the given elements synchronously.\n *\n * @param elements - The elements to typeset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "typeset(elements?: " }, { "kind": "Content", "text": "null | unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "elements", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "typeset" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#typesetClear:member(1)", "docComment": "/**\n * Clear typeset math from the given elements.\n *\n * @param elements - The elements to clear.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "typesetClear(elements?: " }, { "kind": "Content", "text": "null | unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "elements", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "typesetClear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MathJaxEx#typesetPromise:member(1)", "docComment": "/**\n * Typeset math expressions in the given elements asynchronously.\n *\n * @param elements - The elements to typeset.\n *\n * @returns A promise that resolves when typesetting is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "typesetPromise(elements?: " }, { "kind": "Content", "text": "null | unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "elements", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "typesetPromise" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MathJaxEx#version:member", "docComment": "/**\n * MathJax library version string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!Matrix:class", "docComment": "/**\n * 2D transformation matrix.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Matrix " } ], "fileUrlPath": "src/pixi.js/internals/Matrix.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Matrix", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!Matrix#a:member", "docComment": "/**\n * Scale X.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "a: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "a", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Matrix#b:member", "docComment": "/**\n * Shear Y.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "b: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "b", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Matrix#c:member", "docComment": "/**\n * Shear X.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "c: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "c", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Matrix#d:member", "docComment": "/**\n * Scale Y.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "d: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "d", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Matrix#tx:member", "docComment": "/**\n * Translate X.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tx: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Matrix#ty:member", "docComment": "/**\n * Translate Y.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ty: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!MaybeDeferredView:type", "docComment": "/**\n * Union type representing a view that may be either fully loaded or a deferred placeholder.\n *\n * @typeParam TView - The type of the view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type MaybeDeferredView<TView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": "> = " }, { "kind": "Reference", "text": "DeferredView", "canonicalReference": "obsidian-typings!DeferredView:interface" }, { "kind": "Content", "text": " | TView" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/views/MaybeDeferredView.d.ts", "releaseTag": "Public", "name": "MaybeDeferredView", "typeParameters": [ { "typeParameterName": "TView", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MeasureRequest:interface", "docComment": "/**\n * A request for a layout measurement on the editor view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MeasureRequest<T> " } ], "fileUrlPath": "src/@codemirror__view/internals/MeasureRequest.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "MeasureRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MeasureRequest#key:member", "docComment": "/**\n * An optional key used to deduplicate requests.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "key?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MeasureRequest#read:member(1)", "docComment": "/**\n * Read a value from the editor's DOM layout.\n *\n * @param view - The editor view.\n *\n * @returns The measured value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "read(view: " }, { "kind": "Reference", "text": "EditorView", "canonicalReference": "obsidian-typings!~EditorView" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "view", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "read" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MeasureRequest#write:member(1)", "docComment": "/**\n * Write layout changes based on the measured value.\n *\n * @param measure - The measured value.\n *\n * @param view - The editor view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "write?(measure: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ", view: " }, { "kind": "Reference", "text": "EditorView", "canonicalReference": "obsidian-typings!~EditorView" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "measure", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "view", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "write" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MenuSubmenuConfigRecord:interface", "docComment": "/**\n * {@link obsidian#Menu} submenu configuration record.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MenuSubmenuConfigRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Submenu", "canonicalReference": "obsidian-typings!Submenu:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/MenuSubmenuConfigRecord.d.ts", "releaseTag": "Public", "name": "MenuSubmenuConfigRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Mermaid:interface", "docComment": "/**\n * Mermaid library instance for rendering diagrams and charts.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Mermaid " } ], "fileUrlPath": "src/mermaid/internals/Mermaid.d.ts", "releaseTag": "Public", "name": "Mermaid", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#contentLoaded:member(1)", "docComment": "/**\n * Trigger content loaded event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentLoaded(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "contentLoaded" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#detectType:member(1)", "docComment": "/**\n * Detect the type of a Mermaid diagram from its text.\n *\n * @param text - The diagram text.\n *\n * @returns The detected diagram type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detectType(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "detectType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#initialize:member(1)", "docComment": "/**\n * Initialize Mermaid with the given configuration.\n *\n * @param config - The configuration options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialize(config: " }, { "kind": "Reference", "text": "MermaidConfig", "canonicalReference": "obsidian-typings!MermaidConfig:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "initialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#parse:member(1)", "docComment": "/**\n * Parse a Mermaid diagram definition.\n *\n * @param text - The diagram text to parse.\n *\n * @param parseOptions - Options for parsing.\n *\n * @returns A promise resolving to the parse result, or `false` if parsing failed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parse(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", parseOptions?: " }, { "kind": "Reference", "text": "ParseOptions", "canonicalReference": "obsidian-typings!ParseOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<false | " }, { "kind": "Reference", "text": "ParseResult", "canonicalReference": "obsidian-typings!ParseResult:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "parseOptions", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "parse" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#parseError:member(1)", "docComment": "/**\n * Error handler for parse errors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parseError?(err: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", hash: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "err", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "hash", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "parseError" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#registerExternalDiagrams:member(1)", "docComment": "/**\n * Register external diagram definitions.\n *\n * @param diagrams - The external diagram definitions to register.\n *\n * @param opts - Registration options including `lazyLoad`.\n *\n * @returns A promise that resolves when registration is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerExternalDiagrams(diagrams: " }, { "kind": "Reference", "text": "ExternalDiagramDefinition", "canonicalReference": "obsidian-typings!ExternalDiagramDefinition:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", opts?: " }, { "kind": "Reference", "text": "RegisterExternalDiagramsOptions", "canonicalReference": "obsidian-typings!RegisterExternalDiagramsOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "diagrams", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "opts", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ], "name": "registerExternalDiagrams" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#registerIconPacks:member(1)", "docComment": "/**\n * Register icon packs.\n *\n * @param iconLoaders - The icon loader functions to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerIconPacks(iconLoaders: " }, { "kind": "Reference", "text": "IconLoader", "canonicalReference": "obsidian-typings!IconLoader:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "iconLoaders", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "registerIconPacks" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#registerLayoutLoaders:member(1)", "docComment": "/**\n * Register layout loaders.\n *\n * @param loaders - The layout loader definitions to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerLayoutLoaders(loaders: " }, { "kind": "Reference", "text": "LayoutLoaderDefinition", "canonicalReference": "obsidian-typings!LayoutLoaderDefinition:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "loaders", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "registerLayoutLoaders" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#render:member(1)", "docComment": "/**\n * Render a Mermaid diagram.\n *\n * @param id - The ID for the rendered diagram.\n *\n * @param text - The diagram text to render.\n *\n * @param container - Optional container element.\n *\n * @returns A promise resolving to the render result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", container?: " }, { "kind": "Reference", "text": "Element", "canonicalReference": "!Element:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RenderResult", "canonicalReference": "obsidian-typings!RenderResult:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "container", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#run:member(1)", "docComment": "/**\n * Run Mermaid rendering on DOM elements.\n *\n * @param options - Options for the run.\n *\n * @returns A promise that resolves when rendering is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "run(options?: " }, { "kind": "Reference", "text": "RunOptions", "canonicalReference": "obsidian-typings!RunOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "run" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Mermaid#setParseErrorHandler:member(1)", "docComment": "/**\n * Set a custom parse error handler.\n *\n * @param parseErrorHandler - The error handler function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setParseErrorHandler(parseErrorHandler: " }, { "kind": "Content", "text": "(err: unknown, hash: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "parseErrorHandler", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setParseErrorHandler" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Mermaid#startOnLoad:member", "docComment": "/**\n * Whether to start rendering on page load.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startOnLoad: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "startOnLoad", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MermaidConfig:interface", "docComment": "/**\n * Configuration options for Mermaid diagram rendering.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MermaidConfig " } ], "fileUrlPath": "src/mermaid/internals/MermaidConfig.d.ts", "releaseTag": "Public", "name": "MermaidConfig", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!MermaidConfig:index(1)", "docComment": "/**\n * Additional configuration options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#architecture:member", "docComment": "/**\n * Architecture diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "architecture?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "architecture", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#arrowMarkerAbsolute:member", "docComment": "/**\n * Whether to use absolute arrow markers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "arrowMarkerAbsolute?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "arrowMarkerAbsolute", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#block:member", "docComment": "/**\n * Block diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "block?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "block", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#c4:member", "docComment": "/**\n * C4 diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "c4?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "c4", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#class:member", "docComment": "/**\n * Class diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "class?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "class", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#deterministicIds:member", "docComment": "/**\n * Whether to use deterministic IDs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deterministicIds?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "deterministicIds", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#deterministicIDSeed:member", "docComment": "/**\n * Seed for deterministic ID generation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deterministicIDSeed?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "deterministicIDSeed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#er:member", "docComment": "/**\n * Entity relationship diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "er?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "er", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#flowchart:member", "docComment": "/**\n * Flowchart diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "flowchart?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "flowchart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#fontFamily:member", "docComment": "/**\n * Font family for the diagrams.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontFamily?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fontFamily", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#fontSize:member", "docComment": "/**\n * Font size for the diagrams.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontSize?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#gantt:member", "docComment": "/**\n * Gantt chart configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gantt?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "gantt", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#gitGraph:member", "docComment": "/**\n * Git graph configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gitGraph?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "gitGraph", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#journey:member", "docComment": "/**\n * Journey diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "journey?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "journey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#kanban:member", "docComment": "/**\n * Kanban board configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "kanban?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "kanban", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#logLevel:member", "docComment": "/**\n * Log level for Mermaid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "logLevel?: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "logLevel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#maxEdges:member", "docComment": "/**\n * Maximum number of edges allowed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxEdges?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxEdges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#maxTextSize:member", "docComment": "/**\n * Maximum text size allowed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxTextSize?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "maxTextSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#mindmap:member", "docComment": "/**\n * Mindmap diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mindmap?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mindmap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#packet:member", "docComment": "/**\n * Packet diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "packet?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "packet", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#pie:member", "docComment": "/**\n * Pie chart configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pie?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "pie", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#quadrantChart:member", "docComment": "/**\n * Quadrant chart configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "quadrantChart?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "quadrantChart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#requirement:member", "docComment": "/**\n * Requirement diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requirement?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "requirement", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#sankey:member", "docComment": "/**\n * Sankey diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sankey?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sankey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#secure:member", "docComment": "/**\n * List of secure keys.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "secure?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "secure", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#securityLevel:member", "docComment": "/**\n * Security level for rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "securityLevel?: " }, { "kind": "Content", "text": "'antiscript' | 'loose' | 'sandbox' | 'strict'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "securityLevel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#sequence:member", "docComment": "/**\n * Sequence diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sequence?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sequence", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#startOnLoad:member", "docComment": "/**\n * Whether to start rendering on page load.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startOnLoad?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "startOnLoad", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#state:member", "docComment": "/**\n * State diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#suppressErrorRendering:member", "docComment": "/**\n * Whether to suppress error rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suppressErrorRendering?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "suppressErrorRendering", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#theme:member", "docComment": "/**\n * Custom theme name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "theme?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "theme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#themeCSS:member", "docComment": "/**\n * Custom theme CSS.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "themeCSS?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "themeCSS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#themeVariables:member", "docComment": "/**\n * Custom theme variables.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "themeVariables?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "themeVariables", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#timeline:member", "docComment": "/**\n * Timeline diagram configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timeline?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "timeline", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#wrap:member", "docComment": "/**\n * Whether to enable text wrapping.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wrap?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "wrap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MermaidConfig#xy:member", "docComment": "/**\n * XY chart configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "xy?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "xy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataCacheFileCacheRecord:interface", "docComment": "/**\n * Record mapping file paths to their file cache entries (hash, mtime, size).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataCacheFileCacheRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "FileCacheEntry", "canonicalReference": "obsidian-typings!FileCacheEntry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-cache-records/MetadataCacheFileCacheRecord.d.ts", "releaseTag": "Public", "name": "MetadataCacheFileCacheRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataCacheMetadataCacheRecord:interface", "docComment": "/**\n * Record mapping file paths to their parsed cached metadata.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataCacheMetadataCacheRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "CachedMetadata", "canonicalReference": "obsidian!CachedMetadata:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-cache-records/MetadataCacheMetadataCacheRecord.d.ts", "releaseTag": "Public", "name": "MetadataCacheMetadataCacheRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataCacheWorkerMessage:interface", "docComment": "/**\n * Message received from the metadata cache web worker.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataCacheWorkerMessage " } ], "fileUrlPath": "src/obsidian/internals/MetadataCacheWorkerMessage.d.ts", "releaseTag": "Public", "name": "MetadataCacheWorkerMessage", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataCacheWorkerMessage#data:member", "docComment": "/**\n * Parsed cached metadata returned by the worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "CachedMetadata", "canonicalReference": "obsidian!CachedMetadata:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataEditor:interface", "docComment": "/**\n * Editor component for managing frontmatter property fields in a markdown view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataEditor extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/MetadataEditor.d.ts", "releaseTag": "Public", "name": "MetadataEditor", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#_copyToClipboard:member(1)", "docComment": "/**\n * Convert given properties to a serialized object and store in clipboard as obsidian/properties.\n *\n * @param event - The clipboard event.\n *\n * @param properties - Properties to copy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_copyToClipboard(event: " }, { "kind": "Reference", "text": "ClipboardEvent", "canonicalReference": "!ClipboardEvent:interface" }, { "kind": "Content", "text": ", properties: " }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "properties", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "name": "_copyToClipboard" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#addProperty:member(1)", "docComment": "/**\n * Uncollapse editor if collapsed and create a new property row.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addProperty(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "addProperty" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#addPropertyButtonEl:member", "docComment": "/**\n * Button element for adding a new property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addPropertyButtonEl: " }, { "kind": "Reference", "text": "HTMLButtonElement", "canonicalReference": "!HTMLButtonElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "addPropertyButtonEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#clear:member(1)", "docComment": "/**\n * Clear all properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#clearSelection:member(1)", "docComment": "/**\n * Unselect all lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearSelection(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearSelection" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#collapsed:member", "docComment": "/**\n * Whether the frontmatter editor is collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#containerEl:member", "docComment": "/**\n * Container element for the metadata editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#contentEl:member", "docComment": "/**\n * Element containing metadata table and addPropertyButton.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#focusedLine:member", "docComment": "/**\n * The currently focused property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusedLine: " }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusedLine", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#focusKey:member(1)", "docComment": "/**\n * Focus on property field with given key.\n *\n * @param key - Property key to focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusKey(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "focusKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#focusProperty:member(1)", "docComment": "/**\n * Focus on property.\n *\n * @param property - Property to focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusProperty(property: " }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "focusProperty" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#focusPropertyAtIndex:member(1)", "docComment": "/**\n * Focus on property at specified index.\n *\n * @param index - Index of the property to focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusPropertyAtIndex(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "focusPropertyAtIndex" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#focusValue:member(1)", "docComment": "/**\n * Focus on property with value.\n *\n * @param value - Value to focus.\n *\n * @param mode - Focus mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusValue(value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", mode: " }, { "kind": "Reference", "text": "FocusMode", "canonicalReference": "obsidian-typings!FocusMode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "focusValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#foldEl:member", "docComment": "/**\n * Fold button for folding away the frontmatter editor on hovering over headingEl.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "foldEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "foldEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#handleCopy:member(1)", "docComment": "/**\n * Handle copy event on selection and serialize properties.\n *\n * @param event - The clipboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleCopy(event: " }, { "kind": "Reference", "text": "ClipboardEvent", "canonicalReference": "!ClipboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleCopy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#handleCut:member(1)", "docComment": "/**\n * Handle cut event and serialize and remove properties.\n *\n * @param event - The clipboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleCut(event: " }, { "kind": "Reference", "text": "ClipboardEvent", "canonicalReference": "!ClipboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleCut" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#handleItemSelection:member(1)", "docComment": "/**\n * Handle selection of item for drag handling.\n *\n * @param event - The pointer event.\n *\n * @param property - Property being selected.\n *\n * @returns Whether the selection was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleItemSelection(event: " }, { "kind": "Reference", "text": "PointerEvent", "canonicalReference": "!PointerEvent:interface" }, { "kind": "Content", "text": ", property: " }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "handleItemSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#handleKeypress:member(1)", "docComment": "/**\n * Handle key press event for controlling selection or movement of property up/down.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleKeypress(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleKeypress" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#handlePaste:member(1)", "docComment": "/**\n * Handle paste event of properties into metadata editor.\n *\n * @param event - The clipboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handlePaste(event: " }, { "kind": "Reference", "text": "ClipboardEvent", "canonicalReference": "!ClipboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handlePaste" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#hasFocus:member(1)", "docComment": "/**\n * Whether the editor has focus.\n *\n * @returns Whether the editor has focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasFocus(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hasFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#hasPropertyFocused:member(1)", "docComment": "/**\n * Whether there is a property that is focused.\n *\n * @returns Whether a property is focused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasPropertyFocused(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hasPropertyFocused" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#headingEl:member", "docComment": "/**\n * Heading element for the metadata editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headingEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "headingEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#hoverPopover:member", "docComment": "/**\n * Hover element container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverPopover: " }, { "kind": "Reference", "text": "HoverPopover", "canonicalReference": "obsidian!HoverPopover:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverPopover", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#insertProperties:member(1)", "docComment": "/**\n * Add new properties to the metadata editor and save.\n *\n * @param properties - Properties to insert.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertProperties(properties: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "properties", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "insertProperties" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#onload:member(1)", "docComment": "/**\n * On loading of the metadata editor, register on metadata type change event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#onMetadataTypeChange:member(1)", "docComment": "/**\n * On vault metadata update, update property render.\n *\n * @param property - Property that changed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMetadataTypeChange(property: " }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onMetadataTypeChange" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#owner:member", "docComment": "/**\n * Owner of the metadata editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "owner: " }, { "kind": "Reference", "text": "MarkdownView", "canonicalReference": "obsidian!MarkdownView:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "owner", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#properties:member", "docComment": "/**\n * All properties existing in the metadata editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties: " }, { "kind": "Reference", "text": "PropertyEntryData", "canonicalReference": "obsidian-typings!PropertyEntryData:interface" }, { "kind": "Content", "text": "<unknown>[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#propertyListEl:member", "docComment": "/**\n * Element containing all property elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "propertyListEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "propertyListEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#removeProperties:member(1)", "docComment": "/**\n * Remove specified properties from the metadata editor and save, and reset focus if specified.\n *\n * @param properties - Properties to remove.\n *\n * @param resetFocus - Whether to reset focus after removal.\n *\n * @returns The result of the removal operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeProperties(properties: " }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", resetFocus?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "properties", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "resetFocus", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ], "name": "removeProperties" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#rendered:member", "docComment": "/**\n * List of all property field editors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rendered: " }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rendered", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#reorderKey:member(1)", "docComment": "/**\n * Reorder the entry to specified index position and save.\n *\n * @param entry - Property entry to reorder.\n *\n * @param index - Target index position.\n *\n * @returns The result of the reorder operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reorderKey(entry: " }, { "kind": "Reference", "text": "PropertyEntryData", "canonicalReference": "obsidian-typings!PropertyEntryData:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ", index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "entry", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "reorderKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#save:member(1)", "docComment": "/**\n * Serialize the properties and save frontmatter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "save(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "save" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#selectAll:member(1)", "docComment": "/**\n * Select all property fields.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "selectAll" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditor#selectedLines:member", "docComment": "/**\n * Set of all selected property editors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedLines: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectedLines", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#selectProperty:member(1)", "docComment": "/**\n * Mark specified property as selected.\n *\n * @param property - Property to select.\n *\n * @param select - Whether to select or deselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectProperty(property: " }, { "kind": "Reference", "text": "MetadataEditorProperty", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ", select: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "select", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "selectProperty" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#serialize:member(1)", "docComment": "/**\n * Convert properties to a serialized object.\n *\n * @returns Serialized properties object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialize(): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "serialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#setCollapse:member(1)", "docComment": "/**\n * Sets frontmatter as collapsed or uncollapsed.\n *\n * @param collapsed - Whether to collapse.\n *\n * @param x - Whether to animate the transition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapse(collapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", x: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "collapsed", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setCollapse" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#showPropertiesMenu:member(1)", "docComment": "/**\n * On context menu event on header element, show property menu.\n *\n * @param event - The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showPropertiesMenu(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showPropertiesMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#synchronize:member(1)", "docComment": "/**\n * Synchronize data with given properties and re-render them.\n *\n * @param data - Properties data to synchronize with.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "synchronize(data: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "synchronize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditor#toggleCollapse:member(1)", "docComment": "/**\n * Toggle collapsed state of the metadata editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleCollapse(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleCollapse" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataEditorProperty:interface", "docComment": "/**\n * Component representing a single property field in the metadata editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataEditorProperty extends " }, { "kind": "Reference", "text": "Component", "canonicalReference": "obsidian!Component:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/MetadataEditorProperty.d.ts", "releaseTag": "Public", "name": "MetadataEditorProperty", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#containerEl:member", "docComment": "/**\n * Container element for the metadata editor property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#entry:member", "docComment": "/**\n * Entry information for the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "entry: " }, { "kind": "Reference", "text": "PropertyEntryData", "canonicalReference": "obsidian-typings!PropertyEntryData:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "entry", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#focusKey:member(1)", "docComment": "/**\n * Focus on the key input element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusKey(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focusKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#focusProperty:member(1)", "docComment": "/**\n * Focus on the property (container element).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusProperty(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focusProperty" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#focusValue:member(1)", "docComment": "/**\n * Focus on the value input element.\n *\n * @param mode - Focus mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusValue(mode?: " }, { "kind": "Reference", "text": "FocusMode", "canonicalReference": "obsidian-typings!FocusMode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "focusValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#handleItemClick:member(1)", "docComment": "/**\n * Reveal the property menu on click event.\n *\n * @param event - The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleItemClick(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleItemClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#handlePropertyBlur:member(1)", "docComment": "/**\n * Focus on property on blur event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handlePropertyBlur(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "handlePropertyBlur" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#handleUpdateKey:member(1)", "docComment": "/**\n * Update key of property and saves, returns `false` if error.\n *\n * @param key - New key value.\n *\n * @returns Whether the update succeeded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleUpdateKey(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleUpdateKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#handleUpdateValue:member(1)", "docComment": "/**\n * Update value of property and saves.\n *\n * @param value - New value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleUpdateValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleUpdateValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#iconEl:member", "docComment": "/**\n * Icon element of the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconEl: " }, { "kind": "Reference", "text": "HTMLSpanElement", "canonicalReference": "!HTMLSpanElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "iconEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#keyEl:member", "docComment": "/**\n * Key value of the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#keyInputEl:member", "docComment": "/**\n * Input field for key value of the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyInputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyInputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#metadataEditor:member", "docComment": "/**\n * Metadata editor the property is attached to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "metadataEditor: " }, { "kind": "Reference", "text": "MetadataEditor", "canonicalReference": "obsidian-typings!MetadataEditor:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "metadataEditor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#onload:member(1)", "docComment": "/**\n * Loads as draggable property element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onload" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#rendered:member", "docComment": "/**\n * Widget that handles user input for this property widget type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rendered: " }, { "kind": "Reference", "text": "MetadataWidget", "canonicalReference": "obsidian-typings!MetadataWidget:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rendered", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#renderProperty:member(1)", "docComment": "/**\n * Render property widget based on type.\n *\n * @param entry - Property entry data.\n *\n * @param checkErrors - Whether to check for errors.\n *\n * @param useExpectedType - Whether to use the expected type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderProperty(entry: " }, { "kind": "Reference", "text": "PropertyEntryData", "canonicalReference": "obsidian-typings!PropertyEntryData:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ", checkErrors?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", useExpectedType?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "entry", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "checkErrors", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "useExpectedType", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "renderProperty" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#setSelected:member(1)", "docComment": "/**\n * Set the selected class of property.\n *\n * @param selected - Whether to select or deselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSelected(selected: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "selected", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSelected" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#showPropertyMenu:member(1)", "docComment": "/**\n * Reveal property selection menu at mouse event.\n *\n * @param event - The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showPropertyMenu(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showPropertyMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#typeInfo:member", "docComment": "/**\n * Info about the inferred and expected property widget given key-value pair.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "typeInfo: " }, { "kind": "Reference", "text": "TypeInfo", "canonicalReference": "obsidian-typings!TypeInfo:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "typeInfo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#valueEl:member", "docComment": "/**\n * Element that contains the value input or widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "valueEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "valueEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataEditorProperty#warningEl:member", "docComment": "/**\n * Element containing the displayed warning on malformed property field.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "warningEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "warningEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataTypeManager:interface", "docComment": "/**\n * Manager for frontmatter property types, handling registration and assignment of property widgets.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataTypeManager extends " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/MetadataTypeManager.d.ts", "releaseTag": "Public", "name": "MetadataTypeManager", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#_loaded:member", "docComment": "/**\n * Whether the component is currently loaded (from the {@link obsidian#Component} lifecycle).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_loaded: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_loaded", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#assignedWidgets:member", "docComment": "/**\n * Associated widget types for each property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "assignedWidgets: " }, { "kind": "Reference", "text": "MetadataTypeManagerTypesRecord", "canonicalReference": "obsidian-typings!MetadataTypeManagerTypesRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "assignedWidgets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#constructor2__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getMetadataTypeManagerConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor2__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor2__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#getAllProperties:member(1)", "docComment": "/**\n * Get all registered properties of the vault.\n *\n * @returns Record of property names to their info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAllProperties(): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "PropertyInfo", "canonicalReference": "obsidian-typings!PropertyInfo:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAllProperties" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#getAssignedWidget:member(1)", "docComment": "/**\n * Get assigned widget type for property.\n *\n * @param property - Property name.\n *\n * @returns The assigned widget type, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAssignedWidget(property: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "PropertyWidgetType", "canonicalReference": "obsidian-typings!PropertyWidgetType:type" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getAssignedWidget" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#getPropertyInfo:member(1)", "docComment": "/**\n * Get info for property.\n *\n * @param property - Property name.\n *\n * @returns Information about the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPropertyInfo(property: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PropertyInfo", "canonicalReference": "obsidian-typings!PropertyInfo:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPropertyInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#getTypeInfo:member(1)", "docComment": "/**\n * Get expected widget type for property and the one inferred from the property value.\n *\n * @param property - Property name.\n *\n * @param value - Property value.\n *\n * @returns Type information for the property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTypeInfo(property: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypeInfo", "canonicalReference": "obsidian-typings!TypeInfo:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getTypeInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#getWidget:member(1)", "docComment": "/**\n * Get property widget.\n *\n * @param type - Widget type name.\n *\n * @returns The property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getWidget(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getWidget" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#lastSave:member", "docComment": "/**\n * Unix timestamp of the last save\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastSave: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastSave", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#load:member(1)", "docComment": "/**\n * Load metadata type configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "load(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "load" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#loadData:member(1)", "docComment": "/**\n * Load property types from config.\n *\n * @returns A promise that resolves when the property types are loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadData(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadData" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#onConfigFileChange:member", "docComment": "/**\n * Debounced handler for property type config file changes on disk.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onConfigFileChange: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onConfigFileChange", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#onRaw:member(1)", "docComment": "/**\n * Handle raw file system change events for the property type config.\n *\n * @param e - The raw file system change event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRaw(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onRaw" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#properties:member", "docComment": "/**\n * Registered properties of the vault.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties: " }, { "kind": "Reference", "text": "MetadataTypeManagerPropertiesRecord", "canonicalReference": "obsidian-typings!MetadataTypeManagerPropertiesRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#registeredTypeWidgets:member", "docComment": "/**\n * Registered type widgets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registeredTypeWidgets: " }, { "kind": "Reference", "text": "MetadataTypeManagerRegisteredTypeWidgetsRecord", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "registeredTypeWidgets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#registerListeners:member(1)", "docComment": "/**\n * Register event listeners for property type config file changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerListeners(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "registerListeners" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#save:member(1)", "docComment": "/**\n * Save property types to config.\n *\n * @returns A promise that resolves when the property types are saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "save(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "save" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#setType:member(1)", "docComment": "/**\n * Set widget type for property.\n *\n * @param property - Property name.\n *\n * @param type - Widget type to assign.\n *\n * @returns A promise that resolves when the widget type is set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setType(property: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Reference", "text": "PropertyWidgetType", "canonicalReference": "obsidian-typings!PropertyWidgetType:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#unsetType:member(1)", "docComment": "/**\n * Unset widget type for property.\n *\n * @param property - Property name.\n *\n * @returns A promise that resolves when the widget type is unset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unsetType(property: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unsetType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MetadataTypeManager#updatePropertyInfoCache:member(1)", "docComment": "/**\n * Updates `this.properties` to match the {@link obsidian#MetadataCache}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updatePropertyInfoCache(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updatePropertyInfoCache" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataTypeManagerPropertiesRecord:interface", "docComment": "/**\n * Record mapping property names to their metadata information across the vault.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataTypeManagerPropertiesRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "PropertyInfo", "canonicalReference": "obsidian-typings!PropertyInfo:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/MetadataTypeManagerPropertiesRecord.d.ts", "releaseTag": "Public", "name": "MetadataTypeManagerPropertiesRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord:interface", "docComment": "/**\n * Registered type widgets.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataTypeManagerRegisteredTypeWidgetsRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertyWidgetType", "canonicalReference": "obsidian-typings!PropertyWidgetType:type" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/MetadataTypeManagerRegisteredTypeWidgetsRecord.d.ts", "releaseTag": "Public", "name": "MetadataTypeManagerRegisteredTypeWidgetsRecord", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#aliases:member", "docComment": "/**\n * Property widget for aliases.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "aliases: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AliasesPropertyWidgetComponent", "canonicalReference": "obsidian-typings!AliasesPropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "aliases", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#checkbox:member", "docComment": "/**\n * Property widget for checkboxes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkbox: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CheckboxPropertyWidgetComponent", "canonicalReference": "obsidian-typings!CheckboxPropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "checkbox", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#date:member", "docComment": "/**\n * Property widget for dates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "date: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DatePropertyWidgetComponent", "canonicalReference": "obsidian-typings!DatePropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "date", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#datetime:member", "docComment": "/**\n * Property widget for datetimes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "datetime: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DatetimePropertyWidgetComponent", "canonicalReference": "obsidian-typings!DatetimePropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "datetime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#file:member", "docComment": "/**\n * Property widget for files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FilePropertyWidgetComponent", "canonicalReference": "obsidian-typings!FilePropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#folder:member", "docComment": "/**\n * Property widget for folders.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "folder: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FolderPropertyWidgetComponent", "canonicalReference": "obsidian-typings!FolderPropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "folder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#multitext:member", "docComment": "/**\n * Property widget for multitexts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "multitext: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MultitextPropertyWidgetComponent", "canonicalReference": "obsidian-typings!MultitextPropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "multitext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#number:member", "docComment": "/**\n * Property widget for numbers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "number: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NumberPropertyWidgetComponent", "canonicalReference": "obsidian-typings!NumberPropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "number", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#property:member", "docComment": "/**\n * Property widget for properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "property: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponent", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "property", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#tags:member", "docComment": "/**\n * Property widget for tags.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tags: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TagsPropertyWidgetComponent", "canonicalReference": "obsidian-typings!TagsPropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MetadataTypeManagerRegisteredTypeWidgetsRecord#text:member", "docComment": "/**\n * Property widget for text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TextPropertyWidgetComponent", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 7 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataTypeManagerTypesRecord:interface", "docComment": "/**\n * Record mapping property names to their assigned widget entries.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataTypeManagerTypesRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "PropertyWidgetEntry", "canonicalReference": "obsidian-typings!PropertyWidgetEntry:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/MetadataTypeManagerTypesRecord.d.ts", "releaseTag": "Public", "name": "MetadataTypeManagerTypesRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MetadataWidget:interface", "docComment": "/**\n * Base interface for metadata property widgets that render value inputs.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MetadataWidget " } ], "fileUrlPath": "src/obsidian/internals/MetadataWidget.d.ts", "releaseTag": "Public", "name": "MetadataWidget", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MinFunction:interface", "docComment": "/**\n * Function `Min`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MinFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/MinFunction.d.ts", "releaseTag": "Public", "name": "MinFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MinuteFunction:interface", "docComment": "/**\n * Function `Minute`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MinuteFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasExtract", "canonicalReference": "obsidian-typings!HasExtract:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/MinuteFunction.d.ts", "releaseTag": "Public", "name": "MinuteFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MobileFileInfo:interface", "docComment": "/**\n * Interface for rendering file information on mobile.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MobileFileInfo " } ], "fileUrlPath": "src/obsidian/internals/MobileFileInfo.d.ts", "releaseTag": "Public", "name": "MobileFileInfo", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MobileFileInfo#renderCallback:member(1)", "docComment": "/**\n * Callback to render file info into the given element.\n *\n * @param el - The element to render file info into.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderCallback(el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "el", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "renderCallback" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MobileNavbar:interface", "docComment": "/**\n * Navigation bar component for the mobile interface.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MobileNavbar " } ], "fileUrlPath": "src/obsidian/internals/MobileNavbar.d.ts", "releaseTag": "Public", "name": "MobileNavbar", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MobileTabSwitcher:interface", "docComment": "/**\n * Tab switcher component for navigating between open tabs on mobile.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MobileTabSwitcher " } ], "fileUrlPath": "src/obsidian/internals/MobileTabSwitcher.d.ts", "releaseTag": "Public", "name": "MobileTabSwitcher", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#cacheDir:member", "docComment": "/**\n * Directory path for cached tab previews.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cacheDir: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cacheDir", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#close:member(1)", "docComment": "/**\n * Close the currently selected tab.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "close" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#containerEl:member", "docComment": "/**\n * Container element for the tab switcher.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#hide:member(1)", "docComment": "/**\n * Hide the tab switcher UI.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hide(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hide" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#innerScrollEl:member", "docComment": "/**\n * Inner scrollable element containing tab previews.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "innerScrollEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "innerScrollEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#isVisible:member", "docComment": "/**\n * Whether the tab switcher is currently visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isVisible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isVisible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#onLayoutChange:member(1)", "docComment": "/**\n * Handle workspace layout changes by updating the tab list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onLayoutChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onLayoutChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#render:member(1)", "docComment": "/**\n * Render the tab switcher content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#requestRender:member", "docComment": "/**\n * Debounced function to re-render the tab switcher.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestRender: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestRender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#scrollEl:member", "docComment": "/**\n * Scroll container element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scrollEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#setupCacheDir:member(1)", "docComment": "/**\n * Set up the directory for caching tab preview images.\n *\n * @returns A promise that resolves when the cache directory has been set up.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setupCacheDir(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "setupCacheDir" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#show:member(1)", "docComment": "/**\n * Show the tab switcher UI.\n *\n * @returns A promise that resolves when the tab switcher is shown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "show(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "show" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#showTabManagementMenu:member(1)", "docComment": "/**\n * Display the tab management context menu.\n *\n * @param e - The mouse event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showTabManagementMenu(e: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "showTabManagementMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MobileTabSwitcher#tabPreviewLookup:member", "docComment": "/**\n * Weak map caching tab preview images by leaf reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tabPreviewLookup: " }, { "kind": "Reference", "text": "WeakMap", "canonicalReference": "!WeakMap:interface" }, { "kind": "Content", "text": "<object, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tabPreviewLookup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MobileToolbar:interface", "docComment": "/**\n * Toolbar component displayed above the keyboard on mobile.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MobileToolbar " } ], "fileUrlPath": "src/obsidian/internals/MobileToolbar.d.ts", "releaseTag": "Public", "name": "MobileToolbar", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Module:interface", "docComment": "/**\n * An i18next plugin module.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Module " } ], "fileUrlPath": "src/i18next/internals/Module.d.ts", "releaseTag": "Public", "name": "Module", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Module#type:member", "docComment": "/**\n * The type of the module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'3rdParty' | 'backend' | 'formatter' | 'i18nFormat' | 'languageDetector' | 'logger' | 'postProcessor'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ModuleConstructor:interface", "docComment": "/**\n * Constructor for an i18next module.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ModuleConstructor<T extends " }, { "kind": "Reference", "text": "Module", "canonicalReference": "obsidian-typings!Module:interface" }, { "kind": "Content", "text": "> " } ], "fileUrlPath": "src/i18next/internals/ModuleConstructor.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ModuleConstructor", "preserveMemberOrder": false, "members": [ { "kind": "ConstructSignature", "canonicalReference": "obsidian-typings!ModuleConstructor:new(1)", "docComment": "/**\n * Creates a new module instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "new (): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MonthFunction:interface", "docComment": "/**\n * Function `Month`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MonthFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasExtract", "canonicalReference": "obsidian-typings!HasExtract:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/MonthFunction.d.ts", "releaseTag": "Public", "name": "MonthFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!MountedLezerTree:class", "docComment": "/**\n * Represents a tree mounted on a node via a node prop.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class MountedLezerTree " } ], "fileUrlPath": "src/@lezer__common/internals/MountedLezerTree.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "MountedLezerTree", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!MountedLezerTree#overlay:member", "docComment": "/**\n * The regions of the host tree that this mounted tree covers, or `null` if it covers the entire node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly overlay: " }, { "kind": "Content", "text": "null | readonly " }, { "kind": "Reference", "text": "LezerTreeRange", "canonicalReference": "obsidian-typings!LezerTreeRange:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "overlay", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!MountedLezerTree#parser:member", "docComment": "/**\n * The parser that produced this tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly parser: " }, { "kind": "Reference", "text": "Parser", "canonicalReference": "obsidian-typings!Parser:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "parser", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!MountedLezerTree#tree:member", "docComment": "/**\n * The mounted tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly tree: " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "tree", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Multiselect:interface", "docComment": "/**\n * {@link Multiselect} component.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Multiselect " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/Multiselect.d.ts", "releaseTag": "Public", "name": "Multiselect", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#_createElement:member(1)", "docComment": "/**\n * Create a new element for the multiselect.\n *\n * @param value - the value of the element.\n *\n * @returns the created element or `null` if the value is not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_createElement(value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "_createElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#_createInputEl:member(1)", "docComment": "/**\n * Create a new input element for the multiselect.\n *\n * @returns The created input element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_createInputEl(): " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "_createInputEl" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#addElement:member(1)", "docComment": "/**\n * Add a new element to the multiselect.\n *\n * @param value - the value of the element.\n *\n * @returns `true` if the element was added, `false` otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addElement(value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#allowCreatingOptions:member(1)", "docComment": "/**\n * Allow creating options for the multiselect.\n *\n * @param createOption - the function to create an option.\n *\n * @returns the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowCreatingOptions(createOption: " }, { "kind": "Content", "text": "(this: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ", value: string) => string | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "createOption", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "allowCreatingOptions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#changeCallback:member(1)", "docComment": "/**\n * The callback for the change event.\n *\n * @param values - the values of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeCallback?(values: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "changeCallback" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#createOption:member(1)", "docComment": "/**\n * Create a new option for the multiselect.\n *\n * @param value - the value of the option.\n *\n * @returns the created option or `undefined` if the value is not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createOption?(this: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "this", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "createOption" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#editElement:member(1)", "docComment": "/**\n * Edit an element of the multiselect.\n *\n * @param index - the index of the element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "editElement(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "editElement" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Multiselect#elements:member", "docComment": "/**\n * The elements of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "elements: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "elements", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#findDuplicate:member(1)", "docComment": "/**\n * Find a duplicate in the multiselect.\n *\n * @param value - the value that will be checked for being a duplicate.\n *\n * @param values - the values to find a duplicate in.\n *\n * @returns the index of value if duplicate, otherwise `-1`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findDuplicate?(value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", values: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "findDuplicate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#focusElement:member(1)", "docComment": "/**\n * Focus an element of the multiselect.\n *\n * @param index - the index of the element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusElement(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "focusElement" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Multiselect#inputEl:member", "docComment": "/**\n * The input element of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Multiselect#inputText:member", "docComment": "/**\n * The text of the input element of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly inputText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "inputText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#onChange:member(1)", "docComment": "/**\n * Handle the change event of the multiselect.\n *\n * @param changeCallback - the callback to handle the change event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onChange(changeCallback: " }, { "kind": "Content", "text": "(values: string[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "changeCallback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#onOptionContextmenu:member(1)", "docComment": "/**\n * Handle the context menu event of the multiselect.\n *\n * @param menu - the menu to handle the context menu event.\n *\n * @param value - the value of the element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onOptionContextmenu?(this: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ", menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ctx: " }, { "kind": "Reference", "text": "MultiselectOptionContextMenuContext", "canonicalReference": "obsidian-typings!MultiselectOptionContextMenuContext:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "this", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "ctx", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "name": "onOptionContextmenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#optionRenderer:member(1)", "docComment": "/**\n * The renderer for the options of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "optionRenderer?(value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ctx: " }, { "kind": "Reference", "text": "MultiselectOptionContextMenuContext", "canonicalReference": "obsidian-typings!MultiselectOptionContextMenuContext:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ctx", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "optionRenderer" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#preventDuplicates:member(1)", "docComment": "/**\n * Prevent duplicates in the multiselect.\n *\n * @param findDuplicate - the function to find a duplicate.\n *\n * @returns the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preventDuplicates(findDuplicate: " }, { "kind": "Content", "text": "(value: string, values: string[]) => number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "findDuplicate", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "preventDuplicates" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#removeElement:member(1)", "docComment": "/**\n * Remove an element of the multiselect.\n *\n * @param index - the index of the element.\n *\n * @param shouldFocus - Whether to focus the next element after removal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeElement(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", shouldFocus?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "shouldFocus", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "removeElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#renderValues:member(1)", "docComment": "/**\n * Render the values of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderValues(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "renderValues" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Multiselect#rootEl:member", "docComment": "/**\n * The root element of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rootEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rootEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#setInputText:member(1)", "docComment": "/**\n * Set the text of the input element of the multiselect.\n *\n * @param text - the text to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setInputText(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setInputText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#setOptionContextmenuHandler:member(1)", "docComment": "/**\n * Set the context menu handler of the multiselect.\n *\n * @param onOptionContextmenu - the function to handle the context menu event.\n *\n * @returns the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOptionContextmenuHandler(\n onOptionContextmenu: " }, { "kind": "Content", "text": "(\n this: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ",\n menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ",\n value: string,\n ctx: " }, { "kind": "Reference", "text": "MultiselectOptionContextMenuContext", "canonicalReference": "obsidian-typings!MultiselectOptionContextMenuContext:interface" }, { "kind": "Content", "text": "\n ) => void" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "onOptionContextmenu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 8 }, "isOptional": false } ], "name": "setOptionContextmenuHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#setOptionRenderer:member(1)", "docComment": "/**\n * Set the option renderer of the multiselect.\n *\n * @param optionRenderer - the function to render the options.\n *\n * @returns the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOptionRenderer(optionRenderer: " }, { "kind": "Content", "text": "(value: string, ctx: " }, { "kind": "Reference", "text": "MultiselectOptionContextMenuContext", "canonicalReference": "obsidian-typings!MultiselectOptionContextMenuContext:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "optionRenderer", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "setOptionRenderer" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#setupInput:member(1)", "docComment": "/**\n * The setup function for the input element of the multiselect.\n *\n * @param inputEl - the input element.\n *\n * @param initializer - the initializer function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setupInput?(\n this: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ",\n inputEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ",\n initializer: " }, { "kind": "Content", "text": "(value: string, shouldFocus?: boolean) => unknown" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "this", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "inputEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "initializer", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "setupInput" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#setupInputEl:member(1)", "docComment": "/**\n * Set the setup function for the input element of the multiselect.\n *\n * @param setupInput - the function to setup the input element.\n *\n * @returns the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setupInputEl(\n setupInput: " }, { "kind": "Content", "text": "(\n this: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ",\n inputEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ",\n initializer: (value: string, shouldFocus?: boolean) => unknown\n ) => void" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "setupInput", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "setupInputEl" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#setValues:member(1)", "docComment": "/**\n * Set the values of the multiselect.\n *\n * @param values - the values to set.\n *\n * @returns the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValues(values: " }, { "kind": "Content", "text": "null | string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValues" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Multiselect#triggerChange:member(1)", "docComment": "/**\n * Trigger the change event of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "triggerChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "triggerChange" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Multiselect#values:member", "docComment": "/**\n * The values of the multiselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "values: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "values", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MultiselectOptionContextMenuContext:interface", "docComment": "/**\n * {@link Multiselect} option context menu context.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MultiselectOptionContextMenuContext " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/MultiselectOptionContextMenuContext.d.ts", "releaseTag": "Public", "name": "MultiselectOptionContextMenuContext", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MultiselectOptionContextMenuContext#el:member", "docComment": "/**\n * The element of the option context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "el: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "el", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MultiselectOptionContextMenuContext#pillEl:member", "docComment": "/**\n * The pill element of the option context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pillEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pillEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!MultitextPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for multiple texts.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface MultitextPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/MultitextPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "MultitextPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MultitextPropertyWidgetComponent#hoverPopover:member", "docComment": "/**\n * The hover popover for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverPopover: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverPopover", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MultitextPropertyWidgetComponent#multiselect:member", "docComment": "/**\n * The multiselect component for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "multiselect: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "multiselect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MultitextPropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!MultitextPropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MultitextPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'multitext'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!MultitextPropertyWidgetComponent#valueSet:member", "docComment": "/**\n * The values of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "valueSet: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "valueSet", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!NodeConstructor:type", "docComment": "/**\n * Node constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type NodeConstructor<T> = " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<[], T>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/constructors/NodeConstructor.d.ts", "releaseTag": "Public", "name": "NodeConstructor", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NodeInteractionLayer:interface", "docComment": "/**\n * Layer that handles user interactions with canvas nodes, such as resizing and connecting.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NodeInteractionLayer " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/canvas/NodeInteractionLayer.d.ts", "releaseTag": "Public", "name": "NodeInteractionLayer", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NodeInteractionLayer#canvas:member", "docComment": "/**\n * Reference to the parent canvas instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas: " }, { "kind": "Reference", "text": "CanvasViewCanvas", "canonicalReference": "obsidian-typings!CanvasViewCanvas:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NodeInteractionLayer#interactionEl:member", "docComment": "/**\n * HTML element used for rendering interaction handles.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interactionEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "interactionEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NodeInteractionLayer#render:member(1)", "docComment": "/**\n * Render the interaction handles for the current target node.\n *\n * @returns The result of rendering the interaction handles.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NodeInteractionLayer#setTarget:member(1)", "docComment": "/**\n * Set the target node for interaction.\n *\n * @returns The result of setting the target.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setTarget(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setTarget" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NodeInteractionLayer#target:member", "docComment": "/**\n * Currently targeted node for interaction, or `null` if none.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "target: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "target", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!NodeProp:class", "docComment": "/**\n * A node prop is a value associated with node types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class NodeProp<T> " } ], "fileUrlPath": "src/@lezer__common/internals/NodeProp.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isAbstract": false, "name": "NodeProp", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!NodeProp:constructor(1)", "docComment": "/**\n * Create a new node prop.\n *\n * @param config - Configuration for the prop.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(config?: " }, { "kind": "Reference", "text": "NodePropConfig", "canonicalReference": "obsidian-typings!NodePropConfig:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!NodeProp#add:member(1)", "docComment": "/**\n * Create a prop source that adds this prop to matching node types.\n *\n * @param match - A mapping from selectors to values, or a function computing values.\n *\n * @returns A prop source.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add(match: " }, { "kind": "Content", "text": "((type: " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": ") => T | undefined) | " }, { "kind": "Reference", "text": "NodePropSelectorMap", "canonicalReference": "obsidian-typings!NodePropSelectorMap:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "NodePropSource", "canonicalReference": "obsidian-typings!NodePropSource:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "match", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "add" }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeProp.closedBy:member", "docComment": "/**\n * Prop for closed bracket names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static closedBy: " }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<readonly string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "closedBy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeProp.contextHash:member", "docComment": "/**\n * Context hash prop, used to distinguish nodes that would otherwise look the same.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static contextHash: " }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<number>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contextHash", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeProp#deserialize:member", "docComment": "/**\n * A function to deserialize prop values from strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly deserialize: " }, { "kind": "Content", "text": "(str: string) => T" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "deserialize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeProp.group:member", "docComment": "/**\n * Prop for node grouping.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static group: " }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<readonly string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "group", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeProp.lookAhead:member", "docComment": "/**\n * Look-ahead prop, indicating how far the tokenizer looked ahead.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static lookAhead: " }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<number>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lookAhead", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeProp.mounted:member", "docComment": "/**\n * Prop used to mount additional trees on a node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static mounted: " }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MountedLezerTree", "canonicalReference": "obsidian-typings!MountedLezerTree:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mounted", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeProp.openedBy:member", "docComment": "/**\n * Prop for open bracket names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static openedBy: " }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<readonly string[]>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "openedBy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeProp#perNode:member", "docComment": "/**\n * Whether this prop is stored per node rather than per type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly perNode: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "perNode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NodePropConfig:interface", "docComment": "/**\n * Configuration for creating a node prop.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NodePropConfig<T> " } ], "fileUrlPath": "src/@lezer__common/internals/NodePropConfig.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "NodePropConfig", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NodePropConfig#deserialize:member(1)", "docComment": "/**\n * A function to deserialize the prop value from a string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deserialize?(str: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "str", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "deserialize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NodePropConfig#perNode:member", "docComment": "/**\n * Whether this prop is stored per node rather than per type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "perNode?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "perNode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NodePropSelectorMap:interface", "docComment": "/**\n * A mapping from selectors to prop values.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NodePropSelectorMap<T> " } ], "fileUrlPath": "src/@lezer__common/internals/NodePropSelectorMap.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "NodePropSelectorMap", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!NodePropSelectorMap:index(1)", "docComment": "/**\n * A selector mapped to its prop value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[selector: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "selector", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NodePropSource:interface", "docComment": "/**\n * A function that computes a node prop value for a given node type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NodePropSource " } ], "fileUrlPath": "src/@lezer__common/internals/NodePropSource.d.ts", "releaseTag": "Public", "name": "NodePropSource", "preserveMemberOrder": false, "members": [ { "kind": "CallSignature", "canonicalReference": "obsidian-typings!NodePropSource:call(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "(type: " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<unknown>, unknown] | undefined" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!NodeSet:class", "docComment": "/**\n * A set of node types, used to define the types available in a grammar.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class NodeSet " } ], "fileUrlPath": "src/@lezer__common/internals/NodeSet.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "NodeSet", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!NodeSet#types:member", "docComment": "/**\n * The node types in this set, indexed by their id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly types: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "types", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!NodeType:class", "docComment": "/**\n * Represents a type of syntax node in the tree.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class NodeType " } ], "fileUrlPath": "src/@lezer__common/internals/NodeType.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "NodeType", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!NodeType#id:member", "docComment": "/**\n * The numeric id of this node type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeType#name:member", "docComment": "/**\n * The name of this node type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeType.none:member", "docComment": "/**\n * A dummy node type used when no actual type is available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static none: " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "none", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!NodeType#prop:member", "docComment": "/**\n * Retrieve the value of a given node prop for this type.\n *\n * @param prop - The property to look up.\n *\n * @returns The property value, or `undefined` if not set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly prop: " }, { "kind": "Content", "text": "<T>(prop: " }, { "kind": "Reference", "text": "NodeProp", "canonicalReference": "obsidian-typings!NodeProp:class" }, { "kind": "Content", "text": "<T>) => T | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "prop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!normalizeKeyMap:function(1)", "docComment": "/**\n * Normalizes a key map, expanding multi-stroke key bindings.\n *\n * @param keymap - The key map to normalize.\n *\n * @returns The normalized key map.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function normalizeKeyMap(keymap: " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Cm5KeyMap", "canonicalReference": "obsidian-typings!Cm5KeyMap:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/normalizeKeyMap.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "keymap", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "normalizeKeyMap" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NotContainsFunction:interface", "docComment": "/**\n * Function `NotContains`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NotContainsFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/NotContainsFunction.d.ts", "releaseTag": "Public", "name": "NotContainsFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NoteComposerPlugin:interface", "docComment": "/**\n * Internal plugin registration for the note composer (merge/split) feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NoteComposerPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NoteComposerPluginInstance", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/note-composer/NoteComposerPlugin.d.ts", "releaseTag": "Public", "name": "NoteComposerPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance:interface", "docComment": "/**\n * Plugin instance for note composer, providing note merging and splitting functionality.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NoteComposerPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NoteComposerPlugin", "canonicalReference": "obsidian-typings!NoteComposerPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/note-composer/NoteComposerPluginInstance.d.ts", "releaseTag": "Public", "name": "NoteComposerPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#applyTemplate:member(1)", "docComment": "/**\n * Apply a template to content, substituting title placeholders.\n *\n * @param content - The template content.\n *\n * @param fromTitle - The original note title.\n *\n * @param newTitle - The new note title.\n *\n * @returns The processed content with substitutions applied.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applyTemplate(content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", fromTitle: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", newTitle: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fromTitle", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "newTitle", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "applyTemplate" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#extractHeading:member(1)", "docComment": "/**\n * Extract the content under a heading into a new note.\n *\n * @param file - The source file.\n *\n * @param editor - The active editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extractHeading(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", editor: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "extractHeading" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#getSelectionUnderHeading:member(1)", "docComment": "/**\n * Get the text selection range under a heading at the given line.\n *\n * @param file - The source file.\n *\n * @param editor - The active editor.\n *\n * @param line - The line number of the heading.\n *\n * @returns The heading info, or `null` if no heading found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSelectionUnderHeading(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", editor: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": ", line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HeadingInfo", "canonicalReference": "obsidian-typings!HeadingInfo:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "getSelectionUnderHeading" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#onEditorMenu:member(1)", "docComment": "/**\n * Add note composer items to the editor context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param editor - The active editor.\n *\n * @param info - The active markdown view or file info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEditorMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", editor: " }, { "kind": "Reference", "text": "Editor", "canonicalReference": "obsidian!Editor:class" }, { "kind": "Content", "text": ", info: " }, { "kind": "Reference", "text": "MarkdownFileInfo", "canonicalReference": "obsidian!MarkdownFileInfo:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MarkdownView", "canonicalReference": "obsidian!MarkdownView:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "editor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": false } ], "name": "onEditorMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#onEnable:member(1)", "docComment": "/**\n * Called when the plugin is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onEnable(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", plugin: " }, { "kind": "Reference", "text": "NoteComposerPlugin", "canonicalReference": "obsidian-typings!NoteComposerPlugin:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "plugin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onEnable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Handle external settings file changes and reload configuration.\n *\n * @returns A promise that resolves when the settings are reloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#onFileMenu:member(1)", "docComment": "/**\n * Add note composer items to a file context menu.\n *\n * @param menu - The context menu to extend.\n *\n * @param file - The target file.\n *\n * @param source - The source of the context menu event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileMenu(menu: " }, { "kind": "Reference", "text": "Menu", "canonicalReference": "obsidian-typings!~Menu" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", source: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "menu", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onFileMenu" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#options:member", "docComment": "/**\n * Configuration options for the note composer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "NoteComposerPluginOptions", "canonicalReference": "obsidian-typings!NoteComposerPluginOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NoteComposerPluginInstance#pluginInstance:member", "docComment": "/**\n * Reference to the note composer plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pluginInstance: " }, { "kind": "Reference", "text": "NoteComposerPlugin", "canonicalReference": "obsidian-typings!NoteComposerPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pluginInstance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NoteComposerPluginOptions:interface", "docComment": "/**\n * Configuration options for the note composer plugin.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NoteComposerPluginOptions " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/note-composer/NoteComposerPluginOptions.d.ts", "releaseTag": "Public", "name": "NoteComposerPluginOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NoteComposerPluginOptions#askBeforeMerging:member", "docComment": "/**\n * Whether to prompt for confirmation before merging notes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "askBeforeMerging?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "askBeforeMerging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NoteComposerPluginOptions#replacementText:member", "docComment": "/**\n * What to leave in place of extracted content: a link, an embed, or nothing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replacementText?: " }, { "kind": "Content", "text": "'embed' | 'link' | 'none'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "replacementText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NoteComposerPluginOptions#template:member", "docComment": "/**\n * Path to the template file used when extracting content into a new note.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "template?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "template", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NotEmptyFunction:interface", "docComment": "/**\n * Function `NotEmpty`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NotEmptyFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/NotEmptyFunction.d.ts", "releaseTag": "Public", "name": "NotEmptyFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NotEqualFunction:interface", "docComment": "/**\n * Function `NotEqual`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NotEqualFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasCompare", "canonicalReference": "obsidian-typings!HasCompare:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/NotEqualFunction.d.ts", "releaseTag": "Public", "name": "NotEqualFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NotFunction:interface", "docComment": "/**\n * Function `Not`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NotFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/NotFunction.d.ts", "releaseTag": "Public", "name": "NotFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NowFunction:interface", "docComment": "/**\n * Function `Now`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NowFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/NowFunction.d.ts", "releaseTag": "Public", "name": "NowFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!NumberPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for numbers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NumberPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/NumberPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "NumberPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NumberPropertyWidgetComponent#inputEl:member", "docComment": "/**\n * The input element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NumberPropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NumberPropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!NumberPropertyWidgetComponent#showError:member(1)", "docComment": "/**\n * Show the error message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showError(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showError" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!NumberPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'number'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!ObservablePoint:class", "docComment": "/**\n * Observable point that triggers a callback when changed.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ObservablePoint<T = " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "> implements " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/pixi.js/internals/ObservablePoint.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "isAbstract": false, "name": "ObservablePoint", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "obsidian-typings!ObservablePoint#copyFrom:member(1)", "docComment": "/**\n * Copies x and y from the given point.\n *\n * @param p - The point to copy from.\n *\n * @returns This point for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copyFrom(p: " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "p", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "copyFrom" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ObservablePoint#copyTo:member(1)", "docComment": "/**\n * Copies x and y into the given point.\n *\n * @param p - The point to copy into.\n *\n * @returns The target point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "copyTo<U extends " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ">(p: " }, { "kind": "Content", "text": "U" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "U" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "U", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "p", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "copyTo" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ObservablePoint#set:member(1)", "docComment": "/**\n * Sets the point to a new x and y position.\n *\n * @param x - Position on the X axis.\n *\n * @param y - Position on the Y axis.\n *\n * @returns This point for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "set(x?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "set" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ObservablePoint#x:member", "docComment": "/**\n * X coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ObservablePoint#y:member", "docComment": "/**\n * Y coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ObsidianDOM:interface", "docComment": "/**\n * Core DOM elements of the Obsidian application layout.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ObsidianDOM " } ], "fileUrlPath": "src/obsidian/internals/ObsidianDOM.d.ts", "releaseTag": "Public", "name": "ObsidianDOM", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianDOM#appContainerEl:member", "docComment": "/**\n * Root element of the application.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appContainerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "appContainerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ObsidianDOM#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getObsidianDOMConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param containerEl - The containerEl.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "containerEl", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianDOM#horizontalMainContainerEl:member", "docComment": "/**\n * Child of {@link ObsidianDOM.appContainerEl} containing the main content of the application.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "horizontalMainContainerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "horizontalMainContainerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianDOM#statusBarEl:member", "docComment": "/**\n * Status bar element containing word count among other things.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusBarEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusBarEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianDOM#workspaceEl:member", "docComment": "/**\n * Child of {@link ObsidianDOM.horizontalMainContainerEl} containing the workspace DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workspaceEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "workspaceEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ObsidianTouchEvent:interface", "docComment": "/**\n * Represents a touch event processed by Obsidian's gesture system.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ObsidianTouchEvent " } ], "fileUrlPath": "src/obsidian/internals/ObsidianTouchEvent.d.ts", "releaseTag": "Public", "name": "ObsidianTouchEvent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#direction:member", "docComment": "/**\n * Primary axis of the touch gesture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "direction: " }, { "kind": "Content", "text": "'x' | 'y'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "direction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#evt:member", "docComment": "/**\n * The underlying browser touch event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "evt: " }, { "kind": "Reference", "text": "TouchEvent", "canonicalReference": "!TouchEvent:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "evt", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#points:member", "docComment": "/**\n * Number of touch points in the gesture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "points: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "points", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#registerCallback:member", "docComment": "/**\n * Callbacks for managing the touch gesture lifecycle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerCallback: " }, { "kind": "Reference", "text": "ObsidianTouchEventRegisterCallback", "canonicalReference": "obsidian-typings!ObsidianTouchEventRegisterCallback:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "registerCallback", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#startX:member", "docComment": "/**\n * Starting X coordinate of the touch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "startX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#startY:member", "docComment": "/**\n * Starting Y coordinate of the touch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "startY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#targetEl:member", "docComment": "/**\n * Element that the touch event targets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "targetEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "targetEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#touch:member", "docComment": "/**\n * The primary Touch object from the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "touch: " }, { "kind": "Reference", "text": "Touch", "canonicalReference": "!Touch:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "touch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#x:member", "docComment": "/**\n * Current X coordinate of the touch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ObsidianTouchEvent#y:member", "docComment": "/**\n * Current Y coordinate of the touch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ObsidianTouchEventRegisterCallback:interface", "docComment": "/**\n * Callbacks for controlling a touch gesture's lifecycle.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ObsidianTouchEventRegisterCallback " } ], "fileUrlPath": "src/obsidian/internals/ObsidianTouchEventRegisterCallback.d.ts", "releaseTag": "Public", "name": "ObsidianTouchEventRegisterCallback", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ObsidianTouchEventRegisterCallback#cancel:member(1)", "docComment": "/**\n * Cancel the current touch gesture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cancel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ObsidianTouchEventRegisterCallback#finish:member(1)", "docComment": "/**\n * Complete the touch gesture with the final coordinates and velocity.\n *\n * @param x - The final X coordinate.\n *\n * @param y - The final Y coordinate.\n *\n * @param z - The velocity of the gesture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "finish(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", z: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "z", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "finish" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ObsidianTouchEventRegisterCallback#move:member(1)", "docComment": "/**\n * Update the gesture with the current position during movement.\n *\n * @param x - The current X coordinate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "move(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "move" } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!off:function(1)", "docComment": "/**\n * Removes an event handler from the given target.\n *\n * @param target - The target object.\n *\n * @param type - The event type.\n *\n * @param f - The event handler to remove.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function off(target: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", f: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/off.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "off" }, { "kind": "Function", "canonicalReference": "obsidian-typings!on:function(1)", "docComment": "/**\n * Registers an event handler on the given target.\n *\n * @param target - The target object.\n *\n * @param type - The event type.\n *\n * @param f - The event handler.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function on(target: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", f: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/on.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OnProgressParameters:interface", "docComment": "/**\n * Parameters for document loading progress callbacks.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OnProgressParameters " } ], "fileUrlPath": "src/pdfjs-dist/internals/OnProgressParameters.d.ts", "releaseTag": "Public", "name": "OnProgressParameters", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OnProgressParameters#loaded:member", "docComment": "/**\n * Number of bytes loaded so far.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loaded: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "loaded", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OnProgressParameters#total:member", "docComment": "/**\n * Total number of bytes to load.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "total: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "total", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OpenDialogOptions:interface", "docComment": "/**\n * Options for opening an interactive dialog in the editor (e.g., Vim command line).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OpenDialogOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/OpenDialogOptions.d.ts", "releaseTag": "Public", "name": "OpenDialogOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#bottom:member", "docComment": "/**\n * Whether to display the dialog at the bottom of the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#closeOnBlur:member", "docComment": "/**\n * Whether to close the dialog when it loses focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeOnBlur: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "closeOnBlur", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#closeOnEnter:member", "docComment": "/**\n * Whether to close the dialog when the Enter key is pressed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeOnEnter: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "closeOnEnter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#onClose:member(1)", "docComment": "/**\n * Callback invoked when the dialog is closed.\n *\n * @param div - The dialog container element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onClose(div: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "div", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onClose" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#onInput:member(1)", "docComment": "/**\n * Callback invoked when the dialog input value changes.\n *\n * @param e - The keyboard event.\n *\n * @param value - The current input value.\n *\n * @param callback - The callback to invoke with the result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInput(e: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(value: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onInput" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#onKeyDown:member(1)", "docComment": "/**\n * Callback invoked when a key is pressed down in the dialog.\n *\n * @param e - The keyboard event.\n *\n * @param value - The current input value.\n *\n * @param callback - The callback to invoke with the result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyDown(e: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(value: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onKeyDown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#onKeyUp:member(1)", "docComment": "/**\n * Callback invoked when a key is released in the dialog.\n *\n * @param e - The keyboard event.\n *\n * @param value - The current input value.\n *\n * @param callback - The callback to invoke with the result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyUp(e: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(value: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onKeyUp" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#selectValueOnOpen:member", "docComment": "/**\n * Whether to select the input value when the dialog opens.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectValueOnOpen: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectValueOnOpen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OpenDialogOptions#value:member", "docComment": "/**\n * Initial value for the dialog input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OpenNotificationOptions:interface", "docComment": "/**\n * Options for opening a notification in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OpenNotificationOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/OpenNotificationOptions.d.ts", "releaseTag": "Public", "name": "OpenNotificationOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OpenNotificationOptions#bottom:member", "docComment": "/**\n * Whether to display the notification at the bottom of the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OpenNotificationOptions#duration:member", "docComment": "/**\n * Duration in milliseconds before the notification is automatically dismissed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "duration?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "duration", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OutgoingLinkPlugin:interface", "docComment": "/**\n * Internal plugin registration for the outgoing links feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OutgoingLinkPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "OutgoingLinkPluginInstance", "canonicalReference": "obsidian-typings!OutgoingLinkPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/outgoing-link/OutgoingLinkPlugin.d.ts", "releaseTag": "Public", "name": "OutgoingLinkPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OutgoingLinkPluginInstance:interface", "docComment": "/**\n * Plugin instance for outgoing links, displaying links from the current file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OutgoingLinkPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "OutgoingLinkPlugin", "canonicalReference": "obsidian-typings!OutgoingLinkPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/outgoing-link/OutgoingLinkPluginInstance.d.ts", "releaseTag": "Public", "name": "OutgoingLinkPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OutgoingLinkPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OutgoingLinkPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OutgoingLinkPluginInstance#plugin:member", "docComment": "/**\n * Reference to the outgoing link plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "OutgoingLinkPlugin", "canonicalReference": "obsidian-typings!OutgoingLinkPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OutgoingLinkView:interface", "docComment": "/**\n * {@link obsidian#View} that displays outgoing links from the current file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OutgoingLinkView extends " }, { "kind": "Reference", "text": "InfoFileView", "canonicalReference": "obsidian-typings!InfoFileView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/outgoing-link/OutgoingLinkView.d.ts", "releaseTag": "Public", "name": "OutgoingLinkView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutgoingLinkView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The outgoing link view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.OutgoingLink", "canonicalReference": "obsidian-typings!~__type#OutgoingLink:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutgoingLinkView#update:member(1)", "docComment": "/**\n * Refresh the outgoing links list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!Outline:class", "docComment": "/**\n * Represents an SVG outline path for PDF annotations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Outline " } ], "fileUrlPath": "src/pdfjs-dist/internals/Outline.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Outline", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "obsidian-typings!Outline._normalizePagePoint:member(1)", "docComment": "/**\n * Normalize a point relative to the page with the given rotation.\n *\n * @returns The normalized point coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static _normalizePagePoint(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", rotation: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "rotation", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "_normalizePagePoint" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Outline._normalizePoint:member(1)", "docComment": "/**\n * Normalize a point relative to a parent element with the given dimensions and rotation.\n *\n * @returns The normalized point coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static _normalizePoint(\n x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ",\n y: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ",\n parentWidth: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ",\n parentHeight: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ",\n rotation: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "parentWidth", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "parentHeight", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "rotation", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "_normalizePoint" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Outline._rescale:member(1)", "docComment": "/**\n * Rescale coordinates by translation and scale factors.\n *\n * @returns The rescaled coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static _rescale(src: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", tx: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", ty: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", sx: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", sy: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", dest: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "src", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "tx", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "ty", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "sx", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "sy", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "dest", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "_rescale" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Outline._rescaleAndSwap:member(1)", "docComment": "/**\n * Rescale and swap coordinates by translation and scale factors.\n *\n * @returns The rescaled and swapped coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static _rescaleAndSwap(src: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", tx: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", ty: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", sx: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", sy: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", dest: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "src", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "tx", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "ty", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "sx", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "sy", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "dest", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "_rescaleAndSwap" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Outline._translate:member(1)", "docComment": "/**\n * Translate coordinates by the given offsets.\n *\n * @returns The translated coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static _translate(src: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", tx: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", ty: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", dest: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "src", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "tx", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "ty", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "dest", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "_translate" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Outline#box:member", "docComment": "/**\n * The bounding box of the outline.\n *\n * @returns The bounding box of the outline.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get box(): " }, { "kind": "Content", "text": "null | object" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "box", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!Outline.createBezierPoints:member(1)", "docComment": "/**\n * Create cubic bezier control points between two endpoints.\n *\n * @returns The bezier control point coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static createBezierPoints(x1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", x2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", x3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", y3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y1", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "x2", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "y2", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "x3", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "y3", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "createBezierPoints" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Outline.PRECISION:member", "docComment": "/**\n * Number of decimal places used when rounding SVG coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static PRECISION: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "PRECISION", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!Outline#serialize:member(1)", "docComment": "/**\n * Serialize the outline into the PDF page coordinate system.\n *\n * @param bbox - The bounding box as bottom-left and top-right coordinates.\n *\n * @param rotation - The page rotation in degrees.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialize(bbox: " }, { "kind": "Content", "text": "[blX: string, blY: string, trX: string, trY: string]" }, { "kind": "Content", "text": ", rotation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "bbox", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "rotation", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "serialize" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Outline.svgRound:member(1)", "docComment": "/**\n * Round a number to the configured SVG precision.\n *\n * @returns The rounded number.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static svgRound(x: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "svgRound" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Outline#toSVGPath:member(1)", "docComment": "/**\n * Converts the outline to an SVG path.\n *\n * @returns The SVG path of the outline.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toSVGPath(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "toSVGPath" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OutlinePlugin:interface", "docComment": "/**\n * Internal plugin registration for the document outline (table of contents) feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OutlinePlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "OutlinePluginInstance", "canonicalReference": "obsidian-typings!OutlinePluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/outline/OutlinePlugin.d.ts", "releaseTag": "Public", "name": "OutlinePlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OutlinePluginInstance:interface", "docComment": "/**\n * Plugin instance for the outline, displaying headings for the current file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OutlinePluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "OutlinePlugin", "canonicalReference": "obsidian-typings!OutlinePlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/outline/OutlinePluginInstance.d.ts", "releaseTag": "Public", "name": "OutlinePluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OutlinePluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OutlinePluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!OutlinePluginInstance#plugin:member", "docComment": "/**\n * Reference to the outline plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "OutlinePlugin", "canonicalReference": "obsidian-typings!OutlinePlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!OutlineView:interface", "docComment": "/**\n * {@link obsidian#View} that displays the headings outline for the current file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OutlineView extends " }, { "kind": "Reference", "text": "InfoFileView", "canonicalReference": "obsidian-typings!InfoFileView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/outline/OutlineView.d.ts", "releaseTag": "Public", "name": "OutlineView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#constructor3__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param leaf - The workspace leaf.\n *\n * @param outlinePluginInstance - The outline plugin instance.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor3__?(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", outlinePluginInstance: " }, { "kind": "Reference", "text": "OutlinePluginInstance", "canonicalReference": "obsidian-typings!OutlinePluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "outlinePluginInstance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor3__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#createItemDom:member(1)", "docComment": "/**\n * Create a DOM element for an outline heading item.\n *\n * @param e - The heading data.\n *\n * @returns The created DOM element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createItemDom(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createItemDom" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#filterSearchResults:member(1)", "docComment": "/**\n * Filter the outline items based on the current search query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filterSearchResults(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "filterSearchResults" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#findActiveHeading:member(1)", "docComment": "/**\n * Find the heading that corresponds to the current cursor position.\n *\n * @param e - The cursor position or context.\n *\n * @returns The active heading, or `undefined` if none found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findActiveHeading(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "undefined | unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "findActiveHeading" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#findCorrespondingLeaf:member(1)", "docComment": "/**\n * Finds the active leaf.\n *\n * @returns The corresponding workspace leaf, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findCorrespondingLeaf(): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findCorrespondingLeaf" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#getHeadings:member(1)", "docComment": "/**\n * Returns the headings of the active file.\n *\n * @returns The list of heading strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHeadings(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getHeadings" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#getOwner:member(1)", "docComment": "/**\n * Finds the view to the active leaf.\n *\n * @returns The owner view, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOwner(): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getOwner" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The outline view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Outline", "canonicalReference": "obsidian-typings!~__type#Outline:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#handleCollapseAll:member(1)", "docComment": "/**\n * Handle the collapse/expand all toggle action.\n *\n * @param e - Whether to collapse all.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleCollapseAll(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleCollapseAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#handleSelectionChange:member(1)", "docComment": "/**\n * Handle editor selection changes and highlight the active heading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleSelectionChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "handleSelectionChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#onFileChanged:member(1)", "docComment": "/**\n * Handle a file content change and refresh the outline.\n *\n * @param file - The changed file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileChanged(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileChanged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#onMarkdownScroll:member(1)", "docComment": "/**\n * Handle scroll events in the markdown editor and sync outline highlight.\n *\n * @param e - The scroll event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMarkdownScroll(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onMarkdownScroll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#onToggleShowSearch:member(1)", "docComment": "/**\n * Toggles the visibility of the search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onToggleShowSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onToggleShowSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#setHighlightedItem:member(1)", "docComment": "/**\n * Set which outline item is highlighted as active.\n *\n * @param e - The item to highlight.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHighlightedItem(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setHighlightedItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#setShowSearch:member(1)", "docComment": "/**\n * Set the visibility of the search filter.\n *\n * @param e - Whether to show the search filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setShowSearch(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setShowSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#showSearch:member(1)", "docComment": "/**\n * Shows the search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#update:member(1)", "docComment": "/**\n * Refresh the outline view with current headings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!OutlineView#updateSearch:member(1)", "docComment": "/**\n * Updates the search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateSearch" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PagePreviewPlugin:interface", "docComment": "/**\n * Internal plugin registration for the page preview (hover preview) feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PagePreviewPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PagePreviewPluginInstance", "canonicalReference": "obsidian-typings!PagePreviewPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/page-preview/PagePreviewPlugin.d.ts", "releaseTag": "Public", "name": "PagePreviewPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PagePreviewPluginInstance:interface", "docComment": "/**\n * Plugin instance for page preview, showing hover previews of linked notes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PagePreviewPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PagePreviewPlugin", "canonicalReference": "obsidian-typings!PagePreviewPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/page-preview/PagePreviewPluginInstance.d.ts", "releaseTag": "Public", "name": "PagePreviewPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PagePreviewPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PagePreviewPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PageViewport:interface", "docComment": "/**\n * Represents a viewport for a PDF page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PageViewport " } ], "fileUrlPath": "src/pdfjs-dist/internals/PageViewport.d.ts", "releaseTag": "Public", "name": "PageViewport", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PageViewport#clone:member(1)", "docComment": "/**\n * Clones the viewport with optional parameter overrides.\n *\n * @param params - Optional parameters to override including `scale`, `rotation`, `offsetX`, `offsetY`, and `dontFlip`.\n *\n * @returns A new PageViewport instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clone(params?: " }, { "kind": "Reference", "text": "CloneViewportParams", "canonicalReference": "obsidian-typings!CloneViewportParams:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PageViewport", "canonicalReference": "obsidian-typings!PageViewport:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "clone" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PageViewport#convertToPdfPoint:member(1)", "docComment": "/**\n * Converts viewport coordinates to PDF coordinates.\n *\n * @param x - The x coordinate in viewport space.\n *\n * @param y - The y coordinate in viewport space.\n *\n * @returns The PDF coordinates as a tuple.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "convertToPdfPoint(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "[number, number]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "convertToPdfPoint" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PageViewport#convertToViewportPoint:member(1)", "docComment": "/**\n * Converts PDF coordinates to viewport coordinates.\n *\n * @param x - The x coordinate in PDF space.\n *\n * @param y - The y coordinate in PDF space.\n *\n * @returns The viewport coordinates as a tuple.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "convertToViewportPoint(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "[number, number]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "convertToViewportPoint" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PageViewport#height:member", "docComment": "/**\n * Height of the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PageViewport#offsetX:member", "docComment": "/**\n * Horizontal offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offsetX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "offsetX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PageViewport#offsetY:member", "docComment": "/**\n * Vertical offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offsetY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "offsetY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PageViewport#rotation:member", "docComment": "/**\n * Rotation angle in degrees.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rotation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PageViewport#scale:member", "docComment": "/**\n * Scale factor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PageViewport#transform:member", "docComment": "/**\n * Transformation matrix.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transform: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "transform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PageViewport#viewBox:member", "docComment": "/**\n * The view box coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewBox: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewBox", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PageViewport#width:member", "docComment": "/**\n * Width of the viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!parentFolderPath:function(1)", "docComment": "/**\n * Get the parent folder path of a given path.\n *\n * @param path - The path to get the parent folder path of.\n *\n * @returns The parent folder path.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function parentFolderPath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/implementations/utils/PathUtils.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "parentFolderPath" }, { "kind": "Class", "canonicalReference": "obsidian-typings!ParseContext:class", "docComment": "/**\n * A parse context that can be used to track parsing progress.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ParseContext " } ], "fileUrlPath": "src/@codemirror__language/internals/ParseContext.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ParseContext", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "obsidian-typings!ParseContext.get:member(1)", "docComment": "/**\n * Get the current parse context, if any.\n *\n * @returns The current parse context, or `null` if none is active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static get(): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "ParseContext", "canonicalReference": "obsidian-typings!ParseContext:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "get" }, { "kind": "Method", "canonicalReference": "obsidian-typings!ParseContext#skipUntilInView:member(1)", "docComment": "/**\n * Tell the parse context to skip parsing until the given range is in view.\n *\n * @param from - The start of the range.\n *\n * @param to - The end of the range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skipUntilInView(from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "skipUntilInView" }, { "kind": "Property", "canonicalReference": "obsidian-typings!ParseContext#state:member", "docComment": "/**\n * The editor state being parsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly state: " }, { "kind": "Reference", "text": "EditorState", "canonicalReference": "obsidian-typings!~EditorState" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!ParseContext#viewport:member", "docComment": "/**\n * The viewport range currently visible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly viewport: " }, { "kind": "Reference", "text": "ParseContextRange", "canonicalReference": "obsidian-typings!ParseContextRange:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "viewport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ParseContextRange:interface", "docComment": "/**\n * A range with start and end positions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ParseContextRange " } ], "fileUrlPath": "src/@codemirror__language/internals/ParseContextRange.d.ts", "releaseTag": "Public", "name": "ParseContextRange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ParseContextRange#from:member", "docComment": "/**\n * The start position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ParseContextRange#to:member", "docComment": "/**\n * The end position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ParsedLinktext:interface", "docComment": "/**\n * Parsed link text result.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ParsedLinktext " } ], "fileUrlPath": "src/obsidian/internals/ParsedLinktext.d.ts", "releaseTag": "Public", "name": "ParsedLinktext", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ParsedLinktext#path:member", "docComment": "/**\n * The path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ParsedLinktext#subpath:member", "docComment": "/**\n * The subpath.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subpath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ParseOptions:interface", "docComment": "/**\n * Options for parsing Mermaid diagrams.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ParseOptions " } ], "fileUrlPath": "src/mermaid/internals/ParseOptions.d.ts", "releaseTag": "Public", "name": "ParseOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ParseOptions#suppressErrors:member", "docComment": "/**\n * Whether to suppress parse errors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suppressErrors?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "suppressErrors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!Parser:class", "docComment": "/**\n * Abstract base class for parsers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class Parser " } ], "fileUrlPath": "src/@lezer__common/internals/Parser.d.ts", "releaseTag": "Public", "isAbstract": true, "name": "Parser", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "obsidian-typings!Parser#createParse:member(1)", "docComment": "/**\n * Start a parse for the given input.\n *\n * @param input - The document input.\n *\n * @param fragments - Previously parsed fragments that can be reused.\n *\n * @param ranges - The ranges of the document to parse.\n *\n * @returns A partial parse that can be advanced.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "abstract createParse(\n input: " }, { "kind": "Reference", "text": "Input", "canonicalReference": "obsidian-typings!Input:interface" }, { "kind": "Content", "text": ",\n fragments: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "LezerTreeFragment", "canonicalReference": "obsidian-typings!LezerTreeFragment:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ",\n ranges: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "LezerTreeRange", "canonicalReference": "obsidian-typings!LezerTreeRange:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Reference", "text": "PartialParse", "canonicalReference": "obsidian-typings!PartialParse:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fragments", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false }, { "parameterName": "ranges", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 10 }, "isOptional": false } ], "isOptional": false, "isAbstract": true, "name": "createParse" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Parser#parse:member(1)", "docComment": "/**\n * Parse a document.\n *\n * @param input - The document input or string.\n *\n * @param fragments - Previously parsed fragments that can be reused.\n *\n * @param ranges - The ranges of the document to parse.\n *\n * @returns The parsed tree.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parse(\n input: " }, { "kind": "Reference", "text": "Input", "canonicalReference": "obsidian-typings!Input:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ",\n fragments?: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "LezerTreeFragment", "canonicalReference": "obsidian-typings!LezerTreeFragment:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ",\n ranges?: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "LezerTreeRange", "canonicalReference": "obsidian-typings!LezerTreeRange:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 13 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "fragments", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 }, "isOptional": true }, { "parameterName": "ranges", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 11 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "parse" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ParseResult:interface", "docComment": "/**\n * Result of parsing a Mermaid diagram.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ParseResult " } ], "fileUrlPath": "src/mermaid/internals/ParseResult.d.ts", "releaseTag": "Public", "name": "ParseResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ParseResult#diagramType:member", "docComment": "/**\n * The type of diagram that was parsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "diagramType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "diagramType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PartialParse:interface", "docComment": "/**\n * An in-progress parse operation that can be advanced incrementally.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PartialParse " } ], "fileUrlPath": "src/@lezer__common/internals/PartialParse.d.ts", "releaseTag": "Public", "name": "PartialParse", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PartialParse#advance:member(1)", "docComment": "/**\n * Advance the parse by some amount.\n *\n * @returns The finished tree, or `null` if more work is needed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "advance(): " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "advance" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PartialParse#parsedPos:member", "docComment": "/**\n * The position up to which the document has been parsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly parsedPos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "parsedPos", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PartialParse#stopAt:member(1)", "docComment": "/**\n * Tell the parse to stop at a given position.\n *\n * @param pos - The position to stop at.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopAt(pos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "stopAt" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PartialParse#stoppedAt:member", "docComment": "/**\n * The position at which the parse was stopped, or `null` if not stopped.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly stoppedAt: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "stoppedAt", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFDocumentLoadingTask:interface", "docComment": "/**\n * A task representing an ongoing PDF document loading operation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFDocumentLoadingTask " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFDocumentLoadingTask.d.ts", "releaseTag": "Public", "name": "PDFDocumentLoadingTask", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentLoadingTask#destroy:member(1)", "docComment": "/**\n * Destroys the loading task.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentLoadingTask#onPassword:member(1)", "docComment": "/**\n * Callback for password-protected documents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onPassword?(updateCallback: " }, { "kind": "Content", "text": "(password: string) => void" }, { "kind": "Content", "text": ", reason: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "updateCallback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reason", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onPassword" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentLoadingTask#onProgress:member(1)", "docComment": "/**\n * Callback for loading progress updates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onProgress?(progressData: " }, { "kind": "Reference", "text": "OnProgressParameters", "canonicalReference": "obsidian-typings!OnProgressParameters:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "progressData", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onProgress" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFDocumentLoadingTask#promise:member", "docComment": "/**\n * Promise that resolves when the document is loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promise: " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PDFDocumentProxy", "canonicalReference": "obsidian-typings!PDFDocumentProxy:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "promise", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFDocumentProxy:interface", "docComment": "/**\n * Proxy for an opened PDF document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFDocumentProxy " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFDocumentProxy.d.ts", "releaseTag": "Public", "name": "PDFDocumentProxy", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#cleanup:member(1)", "docComment": "/**\n * Cleans up resources held by the document.\n *\n * @param manuallyTriggered - Whether cleanup was manually triggered.\n *\n * @returns A promise that resolves when cleanup is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cleanup(manuallyTriggered?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "manuallyTriggered", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "cleanup" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#destroy:member(1)", "docComment": "/**\n * Destroys the document and releases resources.\n *\n * @returns A promise that resolves when destruction is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "destroy" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#fingerprints:member", "docComment": "/**\n * Document fingerprints.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fingerprints: " }, { "kind": "Content", "text": "[string, null | string]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fingerprints", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getAttachments:member(1)", "docComment": "/**\n * Gets the attachments of the document.\n *\n * @returns A promise resolving to the attachments.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAttachments(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAttachments" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getData:member(1)", "docComment": "/**\n * Gets the raw document data.\n *\n * @returns A promise resolving to the document bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getData(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Uint8Array", "canonicalReference": "!Uint8Array:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getDestination:member(1)", "docComment": "/**\n * Gets a named destination.\n *\n * @param id - The destination identifier.\n *\n * @returns A promise resolving to the destination, or `null` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDestination(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | unknown[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDestination" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getDestinations:member(1)", "docComment": "/**\n * Gets all named destinations.\n *\n * @returns A promise resolving to all destinations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDestinations(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown[]>>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDestinations" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getDownloadInfo:member(1)", "docComment": "/**\n * Gets download information for the document.\n *\n * @returns A promise resolving to download info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDownloadInfo(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PDFDownloadInfo", "canonicalReference": "obsidian-typings!PDFDownloadInfo:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getDownloadInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getMarkInfo:member(1)", "docComment": "/**\n * Gets the mark information for the document.\n *\n * @returns A promise resolving to the mark info, or `null` if not available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMarkInfo(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | " }, { "kind": "Reference", "text": "PDFMarkInfo", "canonicalReference": "obsidian-typings!PDFMarkInfo:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMarkInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getMetadata:member(1)", "docComment": "/**\n * Gets the document metadata.\n *\n * @returns A promise resolving to the metadata.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMetadata(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PDFMetadata", "canonicalReference": "obsidian-typings!PDFMetadata:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMetadata" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getOpenAction:member(1)", "docComment": "/**\n * Gets the open action for the document.\n *\n * @returns A promise resolving to the open action, or `null` if not defined.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOpenAction(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | object>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getOpenAction" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getPage:member(1)", "docComment": "/**\n * Gets a page by its 1-based page number.\n *\n * @param pageNumber - The 1-based page number.\n *\n * @returns A promise resolving to the page proxy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPage(pageNumber: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PDFPageProxy", "canonicalReference": "obsidian-typings!PDFPageProxy:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pageNumber", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getPageIndex:member(1)", "docComment": "/**\n * Gets the page index for a reference object.\n *\n * @param ref - The reference object.\n *\n * @returns A promise resolving to the page index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPageIndex(ref: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<number>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ref", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPageIndex" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getPageLabels:member(1)", "docComment": "/**\n * Gets the page labels.\n *\n * @returns A promise resolving to the labels, or `null` if not defined.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPageLabels(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | string[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPageLabels" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getPageLayout:member(1)", "docComment": "/**\n * Gets the page layout.\n *\n * @returns A promise resolving to the layout name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPageLayout(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPageLayout" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getPageMode:member(1)", "docComment": "/**\n * Gets the page mode.\n *\n * @returns A promise resolving to the mode name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPageMode(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPageMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#getViewerPreferences:member(1)", "docComment": "/**\n * Gets the viewer preferences.\n *\n * @returns A promise resolving to viewer preferences, or `null` if not defined.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewerPreferences(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewerPreferences" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#isPureXfa:member", "docComment": "/**\n * Whether the document is a pure XFA form.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPureXfa: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isPureXfa", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#loadingParams:member", "docComment": "/**\n * Loading parameters used for the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadingParams: " }, { "kind": "Reference", "text": "PDFLoadingParams", "canonicalReference": "obsidian-typings!PDFLoadingParams:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "loadingParams", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#numPages:member", "docComment": "/**\n * Total number of pages.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "numPages: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numPages", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFDocumentProxy#saveDocument:member(1)", "docComment": "/**\n * Saves the document.\n *\n * @returns A promise resolving to the saved document bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveDocument(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Uint8Array", "canonicalReference": "!Uint8Array:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveDocument" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFDownloadInfo:interface", "docComment": "/**\n * Download information for a PDF document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFDownloadInfo " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFDownloadInfo.d.ts", "releaseTag": "Public", "name": "PDFDownloadInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFDownloadInfo#length:member", "docComment": "/**\n * The length of the document in bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PdfExportSettings:interface", "docComment": "/**\n * Settings for PDF export configuration.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PdfExportSettings " } ], "fileUrlPath": "src/obsidian/internals/app-vault-config/PdfExportSettings.d.ts", "releaseTag": "Public", "name": "PdfExportSettings", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfExportSettings#downscalePercent:member", "docComment": "/**\n * The scale percentage applied to the exported PDF.\n *\n * @default\n *\n * `100`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downscalePercent: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "downscalePercent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfExportSettings#landscape:member", "docComment": "/**\n * Whether the PDF is exported in landscape orientation.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "landscape: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "landscape", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfExportSettings#margin:member", "docComment": "/**\n * The page margin setting.\n *\n * @default\n *\n * `'0'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "margin: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "margin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfExportSettings#pageSize:member", "docComment": "/**\n * The page size setting.\n *\n * @default\n *\n * `'letter'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageSize: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pageSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PdfJsModule:interface", "docComment": "/**\n * The PDF.js library module type, representing the `window.pdfjsLib` object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PdfJsModule " } ], "fileUrlPath": "src/pdfjs-dist/internals/PdfJsModule.d.ts", "releaseTag": "Public", "name": "PdfJsModule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfJsModule#build:member", "docComment": "/**\n * The build identifier of the PDF.js library.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "build: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "build", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PdfJsModule#getDocument:member(1)", "docComment": "/**\n * Loads a PDF document from the given source.\n *\n * @param src - The document source.\n *\n * @returns The loading task for the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDocument(src: " }, { "kind": "Reference", "text": "ArrayBuffer", "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DocumentInitParameters", "canonicalReference": "obsidian-typings!DocumentInitParameters:interface" }, { "kind": "Content", "text": " | string | " }, { "kind": "Reference", "text": "Uint8Array", "canonicalReference": "!Uint8Array:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "URL", "canonicalReference": "!URL:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PDFDocumentLoadingTask", "canonicalReference": "obsidian-typings!PDFDocumentLoadingTask:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "src", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 8 }, "isOptional": false } ], "name": "getDocument" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfJsModule#GlobalWorkerOptions:member", "docComment": "/**\n * Global worker options for PDF.js.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "GlobalWorkerOptions: " }, { "kind": "Reference", "text": "GlobalWorkerOptionsType", "canonicalReference": "obsidian-typings!GlobalWorkerOptionsType:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "GlobalWorkerOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfJsModule#version:member", "docComment": "/**\n * The version string of the PDF.js library.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PdfJsTestingUtils:interface", "docComment": "/**\n * Utility interface exposing PDF.js testing helpers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PdfJsTestingUtils " } ], "fileUrlPath": "src/pdfjs-dist/internals/PdfJsTestingUtils.d.ts", "releaseTag": "Public", "name": "PdfJsTestingUtils", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfJsTestingUtils#HighlightOutliner:member", "docComment": "/**\n * Constructor for creating highlight outliners for PDF annotations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "HighlightOutliner: " }, { "kind": "Reference", "text": "HighlightOutliner", "canonicalReference": "obsidian-typings!HighlightOutliner:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "HighlightOutliner", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!pdfJsVersion:var", "docComment": "/**\n * The version string of the PDF.js library.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pdfJsVersion: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/pdfjs-dist/internals/vars/pdfJsVersion.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "pdfJsVersion", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFLoadingParams:interface", "docComment": "/**\n * Loading parameters used for a PDF document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFLoadingParams " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFLoadingParams.d.ts", "releaseTag": "Public", "name": "PDFLoadingParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFLoadingParams#disableAutoFetch:member", "docComment": "/**\n * Whether auto fetch is disabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableAutoFetch: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disableAutoFetch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFLoadingParams#disableStream:member", "docComment": "/**\n * Whether streaming is disabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableStream: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disableStream", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFMarkInfo:interface", "docComment": "/**\n * Mark information for a PDF document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFMarkInfo " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFMarkInfo.d.ts", "releaseTag": "Public", "name": "PDFMarkInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFMarkInfo#Marked:member", "docComment": "/**\n * Whether the document is marked.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Marked: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Marked", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFMarkInfo#Suspects:member", "docComment": "/**\n * Whether the document has suspects.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Suspects: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Suspects", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFMarkInfo#UserProperties:member", "docComment": "/**\n * Whether the document has user properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "UserProperties: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "UserProperties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFMetadata:interface", "docComment": "/**\n * Metadata for a PDF document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFMetadata " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFMetadata.d.ts", "releaseTag": "Public", "name": "PDFMetadata", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFMetadata#contentDispositionFilename:member", "docComment": "/**\n * The content disposition filename, if available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentDispositionFilename: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentDispositionFilename", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFMetadata#contentLength:member", "docComment": "/**\n * The content length, if available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentLength: " }, { "kind": "Content", "text": "null | number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentLength", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFMetadata#info:member", "docComment": "/**\n * Document information dictionary.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "info: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "info", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFMetadata#metadata:member", "docComment": "/**\n * The document metadata, if available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "metadata: " }, { "kind": "Content", "text": "null | unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "metadata", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFPageProxy:interface", "docComment": "/**\n * Proxy for a single PDF page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFPageProxy " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFPageProxy.d.ts", "releaseTag": "Public", "name": "PDFPageProxy", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFPageProxy#cleanup:member(1)", "docComment": "/**\n * Cleans up resources held by the page.\n *\n * @param resetStats - Whether to reset statistics.\n *\n * @returns Whether cleanup was performed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cleanup(resetStats?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "resetStats", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "cleanup" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFPageProxy#getAnnotations:member(1)", "docComment": "/**\n * Gets the annotations for the page.\n *\n * @param params - Optional parameters including `intent` (the rendering intent).\n *\n * @returns A promise resolving to the annotations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAnnotations(params?: " }, { "kind": "Reference", "text": "GetAnnotationsParams", "canonicalReference": "obsidian-typings!GetAnnotationsParams:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getAnnotations" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFPageProxy#getOperatorList:member(1)", "docComment": "/**\n * Gets the operator list for the page.\n *\n * @returns A promise resolving to the operator list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOperatorList(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getOperatorList" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFPageProxy#getTextContent:member(1)", "docComment": "/**\n * Gets the text content of the page.\n *\n * @param params - Optional parameters including `includeMarkedContent` and `disableNormalization`.\n *\n * @returns A promise resolving to the text content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTextContent(params?: " }, { "kind": "Reference", "text": "GetTextContentParams", "canonicalReference": "obsidian-typings!GetTextContentParams:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TextContent", "canonicalReference": "obsidian-typings!TextContent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getTextContent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFPageProxy#getViewport:member(1)", "docComment": "/**\n * Gets the viewport for the page.\n *\n * @param params - Viewport parameters including `scale`, `rotation`, `offsetX`, `offsetY`, and `dontFlip`.\n *\n * @returns The computed viewport.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewport(params: " }, { "kind": "Reference", "text": "GetViewportParams", "canonicalReference": "obsidian-typings!GetViewportParams:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PageViewport", "canonicalReference": "obsidian-typings!PageViewport:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getViewport" }, { "kind": "Property", "canonicalReference": "obsidian-typings!PDFPageProxy#height:member", "docComment": "/**\n * Height of the page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get height(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFPageProxy#pageNumber:member", "docComment": "/**\n * Page number (1-based).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageNumber: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pageNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFPageProxy#ref:member", "docComment": "/**\n * Reference object for the page, if available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ref: " }, { "kind": "Content", "text": "null | object" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ref", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFPageProxy#render:member(1)", "docComment": "/**\n * Renders the page to a canvas context.\n *\n * @param params - Render parameters.\n *\n * @returns The render task.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(params: " }, { "kind": "Reference", "text": "RenderParameters", "canonicalReference": "obsidian-typings!RenderParameters:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "RenderTask", "canonicalReference": "obsidian-typings!RenderTask:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFPageProxy#rotate:member", "docComment": "/**\n * Page rotation angle in degrees.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotate: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rotate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PDFPageProxy#streamTextContent:member(1)", "docComment": "/**\n * Streams the text content of the page.\n *\n * @param params - Optional parameters including `includeMarkedContent` and `disableNormalization`.\n *\n * @returns A readable stream of text content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "streamTextContent(params?: " }, { "kind": "Reference", "text": "GetTextContentParams", "canonicalReference": "obsidian-typings!GetTextContentParams:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ReadableStream", "canonicalReference": "!ReadableStream:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "streamTextContent" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFPageProxy#userUnit:member", "docComment": "/**\n * User unit size.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userUnit: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "userUnit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFPageProxy#view:member", "docComment": "/**\n * The page view box coordinates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "view: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Property", "canonicalReference": "obsidian-typings!PDFPageProxy#width:member", "docComment": "/**\n * Width of the page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get width(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PdfTextStyle:interface", "docComment": "/**\n * Style information for a text item in a PDF page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PdfTextStyle " } ], "fileUrlPath": "src/pdfjs-dist/internals/PdfTextStyle.d.ts", "releaseTag": "Public", "name": "PdfTextStyle", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfTextStyle#ascent:member", "docComment": "/**\n * Ascent of the font.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ascent: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ascent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfTextStyle#descent:member", "docComment": "/**\n * Descent of the font.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "descent: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "descent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfTextStyle#fontFamily:member", "docComment": "/**\n * Font family name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontFamily: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontFamily", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfTextStyle#vertical:member", "docComment": "/**\n * Whether the text is vertical.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vertical: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vertical", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PdfView:interface", "docComment": "/**\n * View for rendering and interacting with PDF files.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PdfView extends " }, { "kind": "Reference", "text": "EditableFileView", "canonicalReference": "obsidian!EditableFileView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/PdfView.d.ts", "releaseTag": "Public", "name": "PdfView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PdfView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The view type identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Pdf", "canonicalReference": "obsidian-typings!~__type#Pdf:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PdfView#onModify:member(1)", "docComment": "/**\n * Is called when the vault has a 'modify' event. Reloads the file if the modified file is the file in this view.\n *\n * @param file - The modified file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onModify(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onModify" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PdfView#showSearch:member(1)", "docComment": "/**\n * Shows the search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showSearch" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PdfView#viewer:member", "docComment": "/**\n * The PDF viewer component used to render the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewer: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!PDFWorker:class", "docComment": "/**\n * PDF.js Web Worker wrapper.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class PDFWorker " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFWorker.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "PDFWorker", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!PDFWorker:constructor(1)", "docComment": "/**\n * Creates a new PDFWorker instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(params?: " }, { "kind": "Reference", "text": "PDFWorkerParams", "canonicalReference": "obsidian-typings!PDFWorkerParams:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!PDFWorker#destroy:member(1)", "docComment": "/**\n * Destroys the worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Method", "canonicalReference": "obsidian-typings!PDFWorker.fromPort:member(1)", "docComment": "/**\n * Creates a PDFWorker from an existing port.\n *\n * @param params - Parameters including the port.\n *\n * @returns A new PDFWorker instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromPort(params: " }, { "kind": "Reference", "text": "PDFWorkerFromPortParams", "canonicalReference": "obsidian-typings!PDFWorkerFromPortParams:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PDFWorker", "canonicalReference": "obsidian-typings!PDFWorker:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "fromPort" }, { "kind": "Method", "canonicalReference": "obsidian-typings!PDFWorker.getWorkerSrc:member(1)", "docComment": "/**\n * Gets the URL of the worker source.\n *\n * @returns The worker source URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static getWorkerSrc(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getWorkerSrc" }, { "kind": "Property", "canonicalReference": "obsidian-typings!PDFWorker#messageHandler:member", "docComment": "/**\n * The message handler for worker communication.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly messageHandler: " }, { "kind": "Content", "text": "null | unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "messageHandler", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PDFWorker#port:member", "docComment": "/**\n * The worker port.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly port: " }, { "kind": "Content", "text": "null | unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "port", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PDFWorker#promise:member", "docComment": "/**\n * Promise that resolves when the worker is ready.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly promise: " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "promise", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFWorkerFromPortParams:interface", "docComment": "/**\n * Parameters for creating a PDFWorker from an existing port.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFWorkerFromPortParams " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFWorkerFromPortParams.d.ts", "releaseTag": "Public", "name": "PDFWorkerFromPortParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFWorkerFromPortParams#port:member", "docComment": "/**\n * The worker port.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "port: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "port", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFWorkerFromPortParams#verbosity:member", "docComment": "/**\n * Verbosity level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "verbosity?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "verbosity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PDFWorkerParams:interface", "docComment": "/**\n * Parameters for creating a PDFWorker instance.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PDFWorkerParams " } ], "fileUrlPath": "src/pdfjs-dist/internals/PDFWorkerParams.d.ts", "releaseTag": "Public", "name": "PDFWorkerParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFWorkerParams#name:member", "docComment": "/**\n * Worker name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFWorkerParams#port:member", "docComment": "/**\n * The worker port.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "port?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "port", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PDFWorkerParams#verbosity:member", "docComment": "/**\n * Verbosity level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "verbosity?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "verbosity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PixiModule:interface", "docComment": "/**\n * The PixiJS library module type, representing the `window.PIXI` object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PixiModule " } ], "fileUrlPath": "src/pixi.js/internals/PixiModule.d.ts", "releaseTag": "Public", "name": "PixiModule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Application:member", "docComment": "/**\n * PixiJS application constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Application: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Application", "canonicalReference": "obsidian-typings!Application:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Application", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Container:member", "docComment": "/**\n * Container constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Container: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Container", "canonicalReference": "obsidian-typings!Container:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Container", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#DisplayObject:member", "docComment": "/**\n * Display object constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "DisplayObject: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "DisplayObject", "canonicalReference": "obsidian-typings!DisplayObject:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "DisplayObject", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Graphics:member", "docComment": "/**\n * Graphics constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Graphics: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Graphics", "canonicalReference": "obsidian-typings!Graphics:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Graphics", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#GraphicsGeometry:member", "docComment": "/**\n * Graphics geometry constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "GraphicsGeometry: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "GraphicsGeometry", "canonicalReference": "obsidian-typings!GraphicsGeometry:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "GraphicsGeometry", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Matrix:member", "docComment": "/**\n * 2D transformation matrix constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Matrix: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Matrix", "canonicalReference": "obsidian-typings!Matrix:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Matrix", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#ObservablePoint:member", "docComment": "/**\n * Observable point constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ObservablePoint: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ObservablePoint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Rectangle:member", "docComment": "/**\n * Rectangle constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Rectangle: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "PixiRectangle", "canonicalReference": "obsidian-typings!PixiRectangle:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Rectangle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Sprite:member", "docComment": "/**\n * Sprite constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Sprite: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Sprite", "canonicalReference": "obsidian-typings!Sprite:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Sprite", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Text:member", "docComment": "/**\n * PixiJS text display object constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Text: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "PixiText", "canonicalReference": "obsidian-typings!PixiText:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#TextStyle:member", "docComment": "/**\n * Text style constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TextStyle: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "TextStyle", "canonicalReference": "obsidian-typings!TextStyle:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TextStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Texture:member", "docComment": "/**\n * Texture resource.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Texture: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Texture", "canonicalReference": "obsidian-typings!Texture:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Texture", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PixiModule#Transform:member", "docComment": "/**\n * Transform constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Transform: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Transform", "canonicalReference": "obsidian-typings!Transform:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Transform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!PixiRectangle:class", "docComment": "/**\n * Rectangle object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class PixiRectangle " } ], "fileUrlPath": "src/pixi.js/internals/PixiRectangle.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "PixiRectangle", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!PixiRectangle:constructor(1)", "docComment": "/**\n * Creates a new rectangle.\n *\n * @param x - X coordinate of the upper-left corner.\n *\n * @param y - Y coordinate of the upper-left corner.\n *\n * @param width - Width of the rectangle.\n *\n * @param height - Height of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(x?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", width?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle#bottom:member", "docComment": "/**\n * Bottom edge of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get bottom(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!PixiRectangle#contains:member(1)", "docComment": "/**\n * Checks whether the given point is inside the rectangle.\n *\n * @param x - X coordinate to test.\n *\n * @param y - Y coordinate to test.\n *\n * @returns Whether the point is contained.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contains(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "contains" }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle.EMPTY:member", "docComment": "/**\n * An empty rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static get EMPTY(): " }, { "kind": "Reference", "text": "PixiRectangle", "canonicalReference": "obsidian-typings!PixiRectangle:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "EMPTY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle#height:member", "docComment": "/**\n * Height of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle#left:member", "docComment": "/**\n * Left edge of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get left(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle#right:member", "docComment": "/**\n * Right edge of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get right(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle#top:member", "docComment": "/**\n * Top edge of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get top(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle#width:member", "docComment": "/**\n * Width of the rectangle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle#x:member", "docComment": "/**\n * X coordinate of the upper-left corner.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiRectangle#y:member", "docComment": "/**\n * Y coordinate of the upper-left corner.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!PixiText:class", "docComment": "/**\n * PixiJS text display object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class PixiText extends " }, { "kind": "Reference", "text": "Sprite", "canonicalReference": "obsidian-typings!Sprite:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/pixi.js/internals/PixiText.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "PixiText", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!PixiText:constructor(1)", "docComment": "/**\n * Creates a new text object.\n *\n * @param text - The text content.\n *\n * @param style - The text style.\n *\n * @param canvas - The canvas to render on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(text?: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ", style?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ITextStyle", "canonicalReference": "obsidian-typings!ITextStyle:interface" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "TextStyle", "canonicalReference": "obsidian-typings!TextStyle:class" }, { "kind": "Content", "text": ", canvas?: " }, { "kind": "Reference", "text": "ICanvas", "canonicalReference": "obsidian-typings!ICanvas:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "style", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": true }, { "parameterName": "canvas", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!PixiText#destroy:member(1)", "docComment": "/**\n * Destroys this text object.\n *\n * @param options - Destroy options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(options?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "IDestroyOptions", "canonicalReference": "obsidian-typings!IDestroyOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiText#height:member", "docComment": "/**\n * Height of the text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get height(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";\n\nset height(value: number);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiText#resolution:member", "docComment": "/**\n * Text resolution.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get resolution(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";\n\nset resolution(value: number);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resolution", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiText#style:member", "docComment": "/**\n * Text style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get style(): " }, { "kind": "Reference", "text": "TextStyle", "canonicalReference": "obsidian-typings!TextStyle:class" }, { "kind": "Content", "text": ";\n\nset style(style: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ITextStyle", "canonicalReference": "obsidian-typings!ITextStyle:interface" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "TextStyle", "canonicalReference": "obsidian-typings!TextStyle:class" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "style", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiText#text:member", "docComment": "/**\n * Text content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get text(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";\n\nset text(text: number | string);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!PixiText#updateText:member(1)", "docComment": "/**\n * Updates the text rendering.\n *\n * @param respectDirty - Whether to respect the dirty flag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateText(respectDirty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "respectDirty", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "updateText" }, { "kind": "Property", "canonicalReference": "obsidian-typings!PixiText#width:member", "docComment": "/**\n * Width of the text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get width(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";\n\nset width(value: number);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PlatformEx:interface", "docComment": "/**\n * Due to limitations of TypeScript, we cannot extend the {@link obsidian#Platform} constant directly.\n *\n * @example\n * ```ts\n * import { Platform } from 'obsidian';\n * import type { PlatformEx } from 'obsidian-typings';\n * const platformEx = Platform as PlatformEx;\n * console.log(platformEx.canDisplayRibbon);\n * ```\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PlatformEx " } ], "fileUrlPath": "src/obsidian/internals/PlatformEx.d.ts", "releaseTag": "Public", "name": "PlatformEx", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#canDisplayRibbon:member", "docComment": "/**\n * Whether the platform supports displaying the sidebar ribbon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canDisplayRibbon: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canDisplayRibbon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#canExportPdf:member", "docComment": "/**\n * Whether the platform supports exporting to PDF.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canExportPdf: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canExportPdf", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#canPopoutWindow:member", "docComment": "/**\n * Whether the platform supports popping out windows.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canPopoutWindow: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canPopoutWindow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#canSplit:member", "docComment": "/**\n * Whether the platform supports splitting panes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canSplit: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canSplit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#canStackTabs:member", "docComment": "/**\n * Whether the platform supports stacking tabs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canStackTabs: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canStackTabs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isAndroidApp:member", "docComment": "/**\n * We're running the `Android` app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAndroidApp: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isAndroidApp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isDesktop:member", "docComment": "/**\n * The UI is in desktop mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDesktop: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isDesktop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isDesktopApp:member", "docComment": "/**\n * We're running the `Electron`-based desktop app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDesktopApp: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isDesktopApp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isIosApp:member", "docComment": "/**\n * We're running the `iOS` app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isIosApp: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isIosApp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isLinux:member", "docComment": "/**\n * We're on a Linux device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isLinux: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isLinux", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isMacOS:member", "docComment": "/**\n * We're on a macOS device, or a device that pretends to be one (like iPhones and iPads). Typically used to detect whether to use command-based hotkeys vs ctrl-based hotkeys.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMacOS: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMacOS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isMobile:member", "docComment": "/**\n * The UI is in mobile mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMobile: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMobile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isMobileApp:member", "docComment": "/**\n * We're running the `Capacitor` mobile app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isMobileApp: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isMobileApp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isPhone:member", "docComment": "/**\n * We're in a mobile app that has very limited screen space.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPhone: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isPhone", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isSafari:member", "docComment": "/**\n * We're running in Safari. Typically used to provide workarounds for Safari bugs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isSafari: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isSafari", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isTablet:member", "docComment": "/**\n * We're in a mobile app that has sufficiently large screen space.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isTablet: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isTablet", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#isWin:member", "docComment": "/**\n * We're on a Windows device.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isWin: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isWin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#mobileDeviceHeight:member", "docComment": "/**\n * Height of the mobile device screen in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mobileDeviceHeight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mobileDeviceHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#mobileKeyboardHeight:member", "docComment": "/**\n * Height of the software keyboard in pixels on mobile.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mobileKeyboardHeight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mobileKeyboardHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#mobileSoftKeyboardVisible:member", "docComment": "/**\n * Whether the software keyboard is currently visible on mobile.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mobileSoftKeyboardVisible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mobileSoftKeyboardVisible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PlatformEx#resourcePathPrefix:member", "docComment": "/**\n * The path prefix for resolving local files on this platform. This returns: - `file:///` on mobile. - `app://random-id/` on desktop (Replaces the old format of `app://local/`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourcePathPrefix: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourcePathPrefix", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!PluginCallback:type", "docComment": "/**\n * Plugin callback function.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type PluginCallback = " }, { "kind": "Content", "text": "(data: unknown) => void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/@capacitor__core/internals/PluginCallback.d.ts", "releaseTag": "Public", "name": "PluginCallback", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PluginHeader:interface", "docComment": "/**\n * Plugin header.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PluginHeader " } ], "fileUrlPath": "src/@capacitor__core/internals/PluginHeader.d.ts", "releaseTag": "Public", "name": "PluginHeader", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PluginHeader#methods:member", "docComment": "/**\n * Plugin methods.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "methods: " }, { "kind": "Reference", "text": "PluginMethodHeader", "canonicalReference": "obsidian-typings!PluginMethodHeader:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "methods", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PluginHeader#name:member", "docComment": "/**\n * Plugin name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PluginImplementations:interface", "docComment": "/**\n * Plugin implementations map.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PluginImplementations " } ], "fileUrlPath": "src/@capacitor__core/internals/PluginImplementations.d.ts", "releaseTag": "Public", "name": "PluginImplementations", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!PluginImplementations:index(1)", "docComment": "/**\n * Plugin implementation for the given platform.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[platform: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "(() => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<[], unknown>>) | " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<[], unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "platform", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PluginListenerHandle:interface", "docComment": "/**\n * Plugin listener handle.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PluginListenerHandle " } ], "fileUrlPath": "src/@capacitor__core/internals/PluginListenerHandle.d.ts", "releaseTag": "Public", "name": "PluginListenerHandle", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PluginListenerHandle#remove:member(1)", "docComment": "/**\n * Removes the listener.\n *\n * @returns Promise that resolves when the listener is removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "remove" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PluginMethodHeader:interface", "docComment": "/**\n * Plugin method header.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PluginMethodHeader " } ], "fileUrlPath": "src/@capacitor__core/internals/PluginMethodHeader.d.ts", "releaseTag": "Public", "name": "PluginMethodHeader", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PluginMethodHeader#name:member", "docComment": "/**\n * Method name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PluginMethodHeader#rtype:member", "docComment": "/**\n * Return type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rtype?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rtype", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!PluginRegistry:type", "docComment": "/**\n * Plugin registry.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type PluginRegistry = " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/@capacitor__core/internals/PluginRegistry.d.ts", "releaseTag": "Public", "name": "PluginRegistry", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Plugins:interface", "docComment": "/**\n * Manager for community plugins, handling installation, enabling, and lifecycle.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Plugins extends " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/plugins/Plugins.d.ts", "releaseTag": "Public", "name": "Plugins", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#autoCheckForUpdates:member", "docComment": "/**\n * Whether automatic update checking is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoCheckForUpdates: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "autoCheckForUpdates", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#checkForDeprecations:member(1)", "docComment": "/**\n * Check online list for deprecated plugins to automatically disable.\n *\n * @returns A promise that resolves when the deprecation check is complete. To get the constructor instance, use {@link getPluginsConstructor} from `obsidian-typings/implementations`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkForDeprecations(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "checkForDeprecations" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#checkForUpdates:member(1)", "docComment": "/**\n * Check for plugin updates.\n *\n * @returns A promise that resolves when the update check is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkForUpdates(showNotice?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "showNotice", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "checkForUpdates" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#constructor2__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getPluginsConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor2__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor2__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#disablePlugin:member(1)", "docComment": "/**\n * Unload a plugin by ID.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @returns A promise that resolves when the plugin is disabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disablePlugin(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "disablePlugin" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#disablePluginAndSave:member(1)", "docComment": "/**\n * Unload a plugin by ID and save config for persistence.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @returns A promise that resolves when the plugin is disabled and the config is saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disablePluginAndSave(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "disablePluginAndSave" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#enabledPlugins:member", "docComment": "/**\n * Set of enabled plugin IDs.\n *\n * @remark\n *\n * The plugin ids aren't guaranteed to be either active (in `app.plugins.plugins`) or installed (in `app.plugins.manifests`).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enabledPlugins: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enabledPlugins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#enablePlugin:member(1)", "docComment": "/**\n * Enable a plugin by ID.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @returns A promise that resolves when the plugin is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enablePlugin(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "enablePlugin" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#enablePluginAndSave:member(1)", "docComment": "/**\n * Enable a plugin by ID and save config for persistence.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @returns A promise that resolves when the plugin is enabled and the config is saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enablePluginAndSave(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "enablePluginAndSave" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#getPlugin:member(1)", "docComment": "/**\n * Get a plugin by ID.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @returns The plugin instance or `null` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPlugin(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Plugin", "canonicalReference": "obsidian!Plugin:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPlugin" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#getPluginFolder:member(1)", "docComment": "/**\n * Get the folder where plugins are stored.\n *\n * @returns Path to the plugins folder.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPluginFolder(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPluginFolder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#initialize:member(1)", "docComment": "/**\n * Load plugin manifests and enable plugins from config.\n *\n * @returns A promise that resolves when initialization is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initialize(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#installPlugin:member(1)", "docComment": "/**\n * Install a plugin from a given URL.\n *\n * @param repo - Repository identifier.\n *\n * @param version - Version to install.\n *\n * @param manifest - {@link obsidian#Plugin} manifest data.\n *\n * @returns A promise that resolves when the plugin is installed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "installPlugin(repo: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", manifest: " }, { "kind": "Reference", "text": "PluginManifest", "canonicalReference": "obsidian!PluginManifest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "repo", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "version", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "manifest", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "installPlugin" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#isDeprecated:member(1)", "docComment": "/**\n * Check whether a plugin is deprecated.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @returns Whether the plugin is deprecated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isDeprecated(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isDeprecated" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#isEnabled:member(1)", "docComment": "/**\n * Check whether community plugins are enabled.\n *\n * @returns Whether community plugins are enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEnabled(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isEnabled" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#lastUpdateCheck:member", "docComment": "/**\n * Timestamp of the last update check.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastUpdateCheck: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastUpdateCheck", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#loadingPluginId:member", "docComment": "/**\n * {@link obsidian#Plugin} ID that is currently being enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadingPluginId: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "loadingPluginId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#loadManifest:member(1)", "docComment": "/**\n * Load a specific plugin's manifest by its folder path.\n *\n * @param path - Folder path containing the manifest.\n *\n * @returns A promise that resolves when the manifest is loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadManifest(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "loadManifest" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#loadManifests:member(1)", "docComment": "/**\n * Load all plugin manifests from plugin folder.\n *\n * @returns A promise that resolves when all manifests are loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadManifests(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadManifests" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#loadPlugin:member(1)", "docComment": "/**\n * Load a plugin by its ID.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @param isUserEnabled - Whether the plugin was enabled by the user.\n *\n * @returns The loaded plugin instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadPlugin(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", isUserEnabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Plugin", "canonicalReference": "obsidian!Plugin:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "isUserEnabled", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadPlugin" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#manifests:member", "docComment": "/**\n * Manifests of all the plugins that are installed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "manifests: " }, { "kind": "Reference", "text": "PluginsManifestsRecord", "canonicalReference": "obsidian-typings!PluginsManifestsRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "manifests", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#onRaw:member(1)", "docComment": "/**\n * Handle raw file system change events for plugin config files.\n *\n * @param e - The raw file system change event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRaw(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onRaw" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#plugins:member", "docComment": "/**\n * Mapping of plugin ID to active plugin instance.\n *\n * @remark\n *\n * Prefer usage of getPlugin to access a plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugins: " }, { "kind": "Reference", "text": "PluginsPluginsRecord", "canonicalReference": "obsidian-typings!PluginsPluginsRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#requestSaveConfig:member", "docComment": "/**\n * Debounced function to save the plugin configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestSaveConfig: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestSaveConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#saveConfig:member(1)", "docComment": "/**\n * Save current plugin configs.\n *\n * @returns A promise that resolves when the config is saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveConfig(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveConfig" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#setAutomaticUpdateCheck:member(1)", "docComment": "/**\n * Set whether automatic update checking is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAutomaticUpdateCheck(enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "enabled", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setAutomaticUpdateCheck" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#setEnable:member(1)", "docComment": "/**\n * Toggle whether community plugins are enabled.\n *\n * @param enabled - Whether to enable community plugins.\n *\n * @returns A promise that resolves when the setting is applied.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setEnable(enabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "enabled", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setEnable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#uninstallPlugin:member(1)", "docComment": "/**\n * Uninstall a plugin by ID.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @returns A promise that resolves when the plugin is uninstalled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uninstallPlugin(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "uninstallPlugin" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Plugins#unloadPlugin:member(1)", "docComment": "/**\n * Unload a plugin by ID.\n *\n * @param id - {@link obsidian#Plugin} ID.\n *\n * @param isUserDisabled - Whether the plugin was disabled by the user.\n *\n * @returns A promise that resolves when the plugin is unloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unloadPlugin(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", isUserDisabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "isUserDisabled", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "unloadPlugin" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Plugins#updates:member", "docComment": "/**\n * Mapping of plugin ID to available updates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updates: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "PluginUpdateManifest", "canonicalReference": "obsidian-typings!PluginUpdateManifest:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "updates", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!plugins:var", "docComment": "/**\n * Registry of Prism plugins.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugins: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" } ], "fileUrlPath": "src/prismjs/internals/vars/plugins.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "plugins", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PluginsManifestsRecord:interface", "docComment": "/**\n * Record mapping plugin IDs to their manifest metadata.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PluginsManifestsRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "PluginManifest", "canonicalReference": "obsidian!PluginManifest:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/plugins/PluginsManifestsRecord.d.ts", "releaseTag": "Public", "name": "PluginsManifestsRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PluginsPluginsRecord:interface", "docComment": "/**\n * Record mapping plugin IDs to their active plugin instances.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PluginsPluginsRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Plugin", "canonicalReference": "obsidian!Plugin:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/plugins/PluginsPluginsRecord.d.ts", "releaseTag": "Public", "name": "PluginsPluginsRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PluginUpdateManifest:interface", "docComment": "/**\n * Information about an available plugin update.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PluginUpdateManifest " } ], "fileUrlPath": "src/obsidian/internals/PluginUpdateManifest.d.ts", "releaseTag": "Public", "name": "PluginUpdateManifest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PluginUpdateManifest#manifest:member", "docComment": "/**\n * Manifest of the plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "manifest: " }, { "kind": "Reference", "text": "PluginManifest", "canonicalReference": "obsidian!PluginManifest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "manifest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PluginUpdateManifest#repo:member", "docComment": "/**\n * Repository of the plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "repo: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "repo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PluginUpdateManifest#version:member", "docComment": "/**\n * New version of the plugin.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!Pos:function(1)", "docComment": "/**\n * A constructor function for creating {@link Position} objects.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Pos: (line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", ch?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", sticky?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" } ], "fileUrlPath": "src/codemirror/internals/vars/Pos.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "line", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ch", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "sticky", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "Pos" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Position:interface", "docComment": "/**\n * A position in a CodeMirror 5 document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Position " } ], "fileUrlPath": "src/codemirror/internals/Position.d.ts", "releaseTag": "Public", "name": "Position", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Position#ch:member", "docComment": "/**\n * Character position within the line.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ch: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Position#line:member", "docComment": "/**\n * Line number (zero-based).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "line: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "line", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Position#sticky:member", "docComment": "/**\n * The sticky direction for cursor placement.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sticky?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sticky", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PositionedReference:interface", "docComment": "/**\n * A reference with position information in the source file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PositionedReference extends " }, { "kind": "Reference", "text": "Reference", "canonicalReference": "obsidian!Reference:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "CacheItem", "canonicalReference": "obsidian!CacheItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/PositionedReference.d.ts", "releaseTag": "Public", "name": "PositionedReference", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PowerTag:interface", "docComment": "/**\n * Power tag.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PowerTag " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/PowerTag.d.ts", "releaseTag": "Public", "name": "PowerTag", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PowerTag#clearGraphics:member(1)", "docComment": "/**\n * Destroy the power tag graphics and remove them from the scene.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearGraphics(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearGraphics" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PowerTag#getTextStyle:member(1)", "docComment": "/**\n * Get the text style used for rendering the power tag label.\n *\n * @returns The text style of the power tag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTextStyle(): " }, { "kind": "Reference", "text": "TextStyle", "canonicalReference": "obsidian-typings!TextStyle:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getTextStyle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PowerTag#initGraphics:member(1)", "docComment": "/**\n * Initialize the power tag graphics and add them to the scene.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initGraphics(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initGraphics" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PowerTag#render:member(1)", "docComment": "/**\n * Render the power tag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PowerTag#rendered:member", "docComment": "/**\n * Whether the power tag graphics have been rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rendered: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rendered", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PowerTag#renderer:member", "docComment": "/**\n * Graph renderer managing this power tag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderer: " }, { "kind": "Reference", "text": "GraphRenderer", "canonicalReference": "obsidian-typings!GraphRenderer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "renderer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PowerTag#text:member", "docComment": "/**\n * PixiJS text element displaying the tag label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Reference", "text": "PIXIText", "canonicalReference": "obsidian-typings!PixiText:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PrismHooks:interface", "docComment": "/**\n * Prism hook system for extending highlighting behavior.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PrismHooks " } ], "fileUrlPath": "src/prismjs/internals/PrismHooks.d.ts", "releaseTag": "Public", "name": "PrismHooks", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismHooks#add:member(1)", "docComment": "/**\n * Registers a callback for a hook.\n *\n * @param name - The hook name.\n *\n * @param callback - The callback to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Reference", "text": "HookCallback", "canonicalReference": "obsidian-typings!HookCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "add" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismHooks#all:member", "docComment": "/**\n * All registered hooks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "all: " }, { "kind": "Reference", "text": "HookTypes", "canonicalReference": "obsidian-typings!HookTypes:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "all", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismHooks#run:member(1)", "docComment": "/**\n * Runs all callbacks registered for a hook.\n *\n * @param name - The hook name.\n *\n * @param env - The environment object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "run(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", env: " }, { "kind": "Reference", "text": "Environment", "canonicalReference": "obsidian-typings!Environment:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "env", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "run" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PrismModule:interface", "docComment": "/**\n * The Prism.js library module type, representing the `window.Prism` object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PrismModule " } ], "fileUrlPath": "src/prismjs/internals/PrismModule.d.ts", "releaseTag": "Public", "name": "PrismModule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismModule#disableWorkerMessageHandler:member", "docComment": "/**\n * Whether to disable the default Prism worker message handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableWorkerMessageHandler: " }, { "kind": "Content", "text": "boolean | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disableWorkerMessageHandler", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismModule#highlight:member(1)", "docComment": "/**\n * Highlights text using a grammar.\n *\n * @param text - The text to highlight.\n *\n * @param grammar - The grammar to use.\n *\n * @param language - The language name.\n *\n * @returns The highlighted HTML string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlight(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", grammar: " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": ", language: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "grammar", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "language", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "highlight" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismModule#highlightAll:member(1)", "docComment": "/**\n * Highlights all code elements on the page.\n *\n * @param async - Whether to use web workers.\n *\n * @param callback - Callback invoked after each element is highlighted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlightAll(async?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "HighlightCallback", "canonicalReference": "obsidian-typings!HighlightCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "async", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "highlightAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismModule#highlightAllUnder:member(1)", "docComment": "/**\n * Highlights all code elements under a container.\n *\n * @param container - The container element.\n *\n * @param async - Whether to use web workers.\n *\n * @param callback - Callback invoked after each element is highlighted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlightAllUnder(container: " }, { "kind": "Reference", "text": "ParentNode", "canonicalReference": "!ParentNode:interface" }, { "kind": "Content", "text": ", async?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "HighlightCallback", "canonicalReference": "obsidian-typings!HighlightCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "container", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "async", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "highlightAllUnder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismModule#highlightElement:member(1)", "docComment": "/**\n * Highlights a single element.\n *\n * @param element - The element to highlight.\n *\n * @param async - Whether to use web workers.\n *\n * @param callback - Callback invoked after the element is highlighted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "highlightElement(element: " }, { "kind": "Reference", "text": "Element", "canonicalReference": "!Element:interface" }, { "kind": "Content", "text": ", async?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Reference", "text": "HighlightCallback", "canonicalReference": "obsidian-typings!HighlightCallback:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "async", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "highlightElement" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismModule#hooks:member", "docComment": "/**\n * The hooks registry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hooks: " }, { "kind": "Reference", "text": "PrismHooks", "canonicalReference": "obsidian-typings!PrismHooks:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hooks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismModule#languages:member", "docComment": "/**\n * The languages registry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "languages: " }, { "kind": "Reference", "text": "Languages", "canonicalReference": "obsidian-typings!Languages:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "languages", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismModule#manual:member", "docComment": "/**\n * Whether Prism should skip automatic highlighting on page load.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "manual: " }, { "kind": "Content", "text": "boolean | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "manual", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismModule#plugins:member", "docComment": "/**\n * Loaded plugins.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugins: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismModule#tokenize:member(1)", "docComment": "/**\n * Tokenizes text using a grammar.\n *\n * @param text - The text to tokenize.\n *\n * @param grammar - The grammar to use.\n *\n * @returns The token stream.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tokenize(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", grammar: " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "grammar", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "tokenize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismModule#util:member", "docComment": "/**\n * Utility functions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "util: " }, { "kind": "Reference", "text": "PrismUtil", "canonicalReference": "obsidian-typings!PrismUtil:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "util", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!PrismToken:class", "docComment": "/**\n * Represents a parsed token produced by Prism's tokenizer.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class PrismToken " } ], "fileUrlPath": "src/prismjs/internals/PrismToken.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "PrismToken", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!PrismToken:constructor(1)", "docComment": "/**\n * Creates a new PrismToken.\n *\n * @param type - The type of the token.\n *\n * @param content - The content of the token.\n *\n * @param alias - Optional alias(es) for the token.\n *\n * @param matchedStr - The original matched string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", content: " }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": "[] | string" }, { "kind": "Content", "text": ", alias?: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ", matchedStr?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", greedy?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "alias", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true }, { "parameterName": "matchedStr", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "isOptional": true }, { "parameterName": "greedy", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!PrismToken#alias:member", "docComment": "/**\n * Alias name(s) for the token type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alias: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "alias", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PrismToken#content:member", "docComment": "/**\n * The content of the token, either a string or nested tokens.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": "[] | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PrismToken#greedy:member", "docComment": "/**\n * Whether the token was matched greedily.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "greedy: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "greedy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!PrismToken#length:member", "docComment": "/**\n * The length of the matched string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!PrismToken.stringify:member(1)", "docComment": "/**\n * Converts a token or token stream to an HTML string.\n *\n * @param o - The token or token stream to stringify.\n *\n * @param language - The language identifier.\n *\n * @returns The stringified HTML representation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static stringify(o: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string> | " }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", language: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", parent?: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "o", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isOptional": false }, { "parameterName": "language", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "isOptional": false }, { "parameterName": "parent", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "stringify" }, { "kind": "Property", "canonicalReference": "obsidian-typings!PrismToken#type:member", "docComment": "/**\n * The type of the token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PrismTokenObject:interface", "docComment": "/**\n * Describes a token pattern for Prism grammar definitions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PrismTokenObject " } ], "fileUrlPath": "src/prismjs/internals/PrismTokenObject.d.ts", "releaseTag": "Public", "name": "PrismTokenObject", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismTokenObject#alias:member", "docComment": "/**\n * Alias name(s) for the token type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alias?: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "alias", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismTokenObject#greedy:member", "docComment": "/**\n * Whether this token is greedy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "greedy?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "greedy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismTokenObject#inside:member", "docComment": "/**\n * Nested grammar applied inside the matched token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inside?: " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inside", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismTokenObject#lookbehind:member", "docComment": "/**\n * Whether to apply lookbehind to the pattern.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lookbehind?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lookbehind", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PrismTokenObject#pattern:member", "docComment": "/**\n * The regex pattern to match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pattern: " }, { "kind": "Reference", "text": "RegExp", "canonicalReference": "!RegExp:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pattern", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!PrismTokenStream:type", "docComment": "/**\n * A token stream: a string, a single token, or an array of strings and tokens.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type PrismTokenStream = " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string> | " }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/PrismTokenStream.d.ts", "releaseTag": "Public", "name": "PrismTokenStream", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PrismUtil:interface", "docComment": "/**\n * Prism utility functions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PrismUtil " } ], "fileUrlPath": "src/prismjs/internals/PrismUtil.d.ts", "releaseTag": "Public", "name": "PrismUtil", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismUtil#clone:member(1)", "docComment": "/**\n * Deep clones an object.\n *\n * @param o - The object to clone.\n *\n * @returns A deep clone of the object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clone<T>(o: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "o", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "clone" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismUtil#encode:member(1)", "docComment": "/**\n * Encodes tokens by replacing special HTML characters.\n *\n * @param tokens - The token stream to encode.\n *\n * @returns The encoded token stream.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "encode(tokens: " }, { "kind": "Reference", "text": "PrismTokenStream", "canonicalReference": "obsidian-typings!PrismTokenStream:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PrismTokenStream", "canonicalReference": "obsidian-typings!PrismTokenStream:type" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "tokens", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "encode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismUtil#objId:member(1)", "docComment": "/**\n * Returns a unique identifier for the given object.\n *\n * @param obj - The object to identify.\n *\n * @returns The unique numeric identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "objId(obj: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "obj", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "objId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PrismUtil#type:member(1)", "docComment": "/**\n * Returns the type of the given value as a string.\n *\n * @param o - The value to check.\n *\n * @returns The type string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type(o: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "o", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "type" } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ProgressCallback:type", "docComment": "/**\n * Callback function invoked during scrypt key derivation to report progress.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ProgressCallback = " }, { "kind": "Content", "text": "(progress: number) => boolean | void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/scrypt-js/internals/ProgressCallback.d.ts", "releaseTag": "Public", "name": "ProgressCallback", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PromisedQueue:interface", "docComment": "/**\n * A sequential promise queue that ensures functions execute one at a time.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PromisedQueue " } ], "fileUrlPath": "src/obsidian/internals/PromisedQueue.d.ts", "releaseTag": "Public", "name": "PromisedQueue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PromisedQueue#promise:member", "docComment": "/**\n * The current promise in the queue chain.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promise: " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "promise", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PromisedQueue#queue:member(1)", "docComment": "/**\n * Add a function to the queue and return a promise for its result.\n *\n * @param fn - The function to enqueue.\n *\n * @returns A promise that resolves with the function's result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queue<T>(fn: " }, { "kind": "Content", "text": "() => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<T> | T" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "queue" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PromiseWithResolvers:interface", "docComment": "/**\n * A promise bundled with its `resolve` and `reject` callbacks, as returned by `Promise.withResolvers()`.\n *\n * Mirrors the ES2024 `PromiseWithResolvers` global so the typings stay consumable when the consumer's `lib` only targets ES2022 (e.g. the minimum supported Obsidian installer, which runs on Node 16).\n *\n * @typeParam T - The type the promise resolves to.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PromiseWithResolvers<T> " } ], "fileUrlPath": "src/obsidian/internals/collections/PromiseWithResolvers.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "PromiseWithResolvers", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PromiseWithResolvers#promise:member", "docComment": "/**\n * The pending promise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promise: " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "promise", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PromiseWithResolvers#reject:member(1)", "docComment": "/**\n * Rejects {@link PromiseWithResolvers.promise}.\n *\n * @param reason - The rejection reason.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reject(reason?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reason", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "reject" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PromiseWithResolvers#resolve:member(1)", "docComment": "/**\n * Resolves {@link PromiseWithResolvers.promise}.\n *\n * @param value - The resolution value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolve(value: " }, { "kind": "Reference", "text": "PromiseLike", "canonicalReference": "!PromiseLike:interface" }, { "kind": "Content", "text": "<T> | T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "resolve" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertiesPlugin:interface", "docComment": "/**\n * Internal plugin registration for the properties (frontmatter metadata) feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertiesPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertiesPluginInstance", "canonicalReference": "obsidian-typings!PropertiesPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/properties/PropertiesPlugin.d.ts", "releaseTag": "Public", "name": "PropertiesPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertiesPluginInstance:interface", "docComment": "/**\n * Plugin instance for properties, managing frontmatter metadata views.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertiesPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertiesPlugin", "canonicalReference": "obsidian-typings!PropertiesPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/properties/PropertiesPluginInstance.d.ts", "releaseTag": "Public", "name": "PropertiesPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertiesPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertiesPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertiesPluginInstance#plugin:member", "docComment": "/**\n * Reference to the properties plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "PropertiesPlugin", "canonicalReference": "obsidian-typings!PropertiesPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyEntryData:interface", "docComment": "/**\n * Data for a single frontmatter property entry.\n *\n * @typeParam T - The type of the property value.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyEntryData<T> " } ], "fileUrlPath": "src/obsidian/internals/PropertyEntryData.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "PropertyEntryData", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyEntryData#key:member", "docComment": "/**\n * Property key.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyEntryData#type:member", "docComment": "/**\n * Property widget type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyEntryData#value:member", "docComment": "/**\n * Property value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyInfo:interface", "docComment": "/**\n * Information about a frontmatter property across the vault.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyInfo " } ], "fileUrlPath": "src/obsidian/internals/PropertyInfo.d.ts", "releaseTag": "Public", "name": "PropertyInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyInfo#name:member", "docComment": "/**\n * Name of property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyInfo#occurrences:member", "docComment": "/**\n * Usage count of property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "occurrences: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "occurrences", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyInfo#widget:member", "docComment": "/**\n * Type of property.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "widget: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "widget", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for properties.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/PropertyPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "PropertyPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponent#combobox:member", "docComment": "/**\n * The combobox component for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "combobox: " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBox", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "combobox", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponent#inputEl:member", "docComment": "/**\n * The input element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'property'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox:interface", "docComment": "/**\n * Combobox component for {@link PropertyPropertyWidgetComponent}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyPropertyWidgetComponentComboBox extends " }, { "kind": "Reference", "text": "PopoverSuggest", "canonicalReference": "obsidian!PopoverSuggest:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/PropertyPropertyWidgetComponentComboBox.d.ts", "releaseTag": "Public", "name": "PropertyPropertyWidgetComponentComboBox", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#_items:member", "docComment": "/**\n * The items of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_items: " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#_onClose:member(1)", "docComment": "/**\n * Callback for {@link PropertyPropertyWidgetComponentComboBox.onClose}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_onClose?(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "_onClose" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#_onOpen:member(1)", "docComment": "/**\n * Callback for {@link PropertyPropertyWidgetComponentComboBox.onOpen}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_onOpen?(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "_onOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#attachDom:member(1)", "docComment": "/**\n * Attach the DOM of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "attachDom(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "attachDom" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#bgEl:member", "docComment": "/**\n * The background element of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bgEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bgEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#buttonEl:member", "docComment": "/**\n * The button element of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttonEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "buttonEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#clearable:member", "docComment": "/**\n * Whether the combobox is clearable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clearable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#detachDom:member(1)", "docComment": "/**\n * Detach the DOM of the combobox.\n *\n * @returns A promise that resolves when the DOM is detached.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detachDom(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "detachDom" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#focus:member(1)", "docComment": "/**\n * Focus the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "focus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#getItems:member(1)", "docComment": "/**\n * Get the items of the combobox.\n *\n * @returns The combobox items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getItems(): " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getItems" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#getSuggestions:member(1)", "docComment": "/**\n * Callback for {@link PropertyPropertyWidgetComponentComboBox.getSuggestions}.\n *\n * @param query - The search query string.\n *\n * @returns The matching search results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSuggestions(query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSuggestions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#iconEl:member", "docComment": "/**\n * The icon element of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "iconEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "iconEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#labelEl:member", "docComment": "/**\n * The label element of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "labelEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "labelEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#onClose:member(1)", "docComment": "/**\n * Register a callback for `close` event.\n *\n * @param callback - the callback to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onClose(callback: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onClose" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#onInputChange:member(1)", "docComment": "/**\n * Handle the input change event of the combobox.\n *\n * @param query - the query to handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInputChange(query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onInputChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#onOpen:member(1)", "docComment": "/**\n * Register a callback for `open` event.\n *\n * @param callback - the callback to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onOpen(callback: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#onSelect:member(1)", "docComment": "/**\n * Register a callback for `select` event.\n *\n * @param callback - the callback to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSelect(callback: " }, { "kind": "Content", "text": "(item: " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "onSelect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#renderLabel:member(1)", "docComment": "/**\n * Render the label of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderLabel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "renderLabel" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#searchComponent:member", "docComment": "/**\n * The search component of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchComponent: " }, { "kind": "Reference", "text": "SearchComponent", "canonicalReference": "obsidian!SearchComponent:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchComponent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#selectCb:member(1)", "docComment": "/**\n * Callback for {@link PropertyPropertyWidgetComponentComboBox.onSelect}.\n *\n * @param item - the item that was selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectCb?(item: " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "selectCb" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#setClearable:member(1)", "docComment": "/**\n * Set the clearable state of the combobox.\n *\n * @param clearable - whether the combobox should be clearable.\n *\n * @returns the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setClearable(clearable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "clearable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setClearable" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#setItems:member(1)", "docComment": "/**\n * Set the items of the combobox.\n *\n * @param items - the items to set.\n *\n * @returns the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setItems(items: " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "items", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "setItems" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#setPlaceholder:member(1)", "docComment": "/**\n * Set the placeholder of the combobox.\n *\n * @param placeholder - the placeholder to set.\n *\n * @returns the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPlaceholder(placeholder: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "placeholder", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setPlaceholder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#setValue:member(1)", "docComment": "/**\n * Set the value of the combobox.\n *\n * @param value - the value to set.\n *\n * @returns the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#setValueById:member(1)", "docComment": "/**\n * Set the value of the combobox by its id.\n *\n * @param id - the id of the value to set.\n *\n * @returns the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValueById(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValueById" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#toggle:member(1)", "docComment": "/**\n * Toggle the combobox.\n *\n * @returns The result of toggling the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggle(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#updateValue:member(1)", "docComment": "/**\n * Update the value of the combobox.\n *\n * @param value - the value to update.\n *\n * @returns the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateValue(value: " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBox#value:member", "docComment": "/**\n * The current value of the combobox.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "PropertyPropertyWidgetComponentComboBoxItem", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem:interface", "docComment": "/**\n * Combo box item for {@link PropertyPropertyWidgetComponentComboBox}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyPropertyWidgetComponentComboBoxItem " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/PropertyPropertyWidgetComponentComboBoxItem.d.ts", "releaseTag": "Public", "name": "PropertyPropertyWidgetComponentComboBoxItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem#icon:member", "docComment": "/**\n * The icon of the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyPropertyWidgetComponentComboBoxItem#value:member", "docComment": "/**\n * The value of the item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyRenderContext:interface", "docComment": "/**\n * Context provided to property widgets for rendering and interaction.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyRenderContext " } ], "fileUrlPath": "src/obsidian/internals/PropertyRenderContext.d.ts", "releaseTag": "Public", "name": "PropertyRenderContext", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyRenderContext#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyRenderContext#blur:member(1)", "docComment": "/**\n * Callback called on property field unfocus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blur(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "blur" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyRenderContext#key:member", "docComment": "/**\n * Key of the property field.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyRenderContext#onChange:member(1)", "docComment": "/**\n * Callback called on property value change.\n *\n * @param value - The new property value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onChange(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onChange" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyRenderContext#sourcePath:member", "docComment": "/**\n * Determine the source path of current context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sourcePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sourcePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyWidget:interface", "docComment": "/**\n * Property widget.\n *\n * @typeParam ComponentType - The type of the component.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyWidget<ComponentType extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": "> " } ], "fileUrlPath": "src/obsidian/internals/PropertyWidget.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "ComponentType", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "PropertyWidget", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyWidget#icon:member", "docComment": "/**\n * Lucide-dev icon associated with the widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyWidget#name:member(1)", "docComment": "/**\n * Returns the I18N name of the widget.\n *\n * @returns The localized name of the widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "name" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyWidget#render:member(1)", "docComment": "/**\n * Render function for the widget on field container given context and data.\n *\n * @param containerEl - The container element to render the widget into.\n *\n * @param data - The property data to render.\n *\n * @param context - The rendering context for the property.\n *\n * @returns The rendered widget component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", data: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", context: " }, { "kind": "Reference", "text": "PropertyRenderContext", "canonicalReference": "obsidian-typings!PropertyRenderContext:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "ComponentType" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "containerEl", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "context", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "render" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyWidget#reservedKeys:member", "docComment": "/**\n * Reserved keys for the widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reservedKeys?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "reservedKeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyWidget#type:member", "docComment": "/**\n * Identifier for the widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyWidget#validate:member(1)", "docComment": "/**\n * Validate whether the input value to the widget is correct.\n *\n * @param value - The value to validate.\n *\n * @returns Whether the value is valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "validate(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "validate" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface", "docComment": "/**\n * Base class for property widget components.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyWidgetComponentBase " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/PropertyWidgetComponentBase.d.ts", "releaseTag": "Public", "name": "PropertyWidgetComponentBase", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase#focus:member(1)", "docComment": "/**\n * Focus the property widget.\n *\n * @param mode - The focus mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus(mode?: " }, { "kind": "Reference", "text": "FocusMode", "canonicalReference": "obsidian-typings!FocusMode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "focus" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PropertyWidgetEntry:interface", "docComment": "/**\n * Entry associating a display name with a property widget type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PropertyWidgetEntry " } ], "fileUrlPath": "src/obsidian/internals/PropertyWidgetEntry.d.ts", "releaseTag": "Public", "name": "PropertyWidgetEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyWidgetEntry#name:member", "docComment": "/**\n * Display name of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PropertyWidgetEntry#widget:member", "docComment": "/**\n * The property widget type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "widget: " }, { "kind": "Reference", "text": "PropertyWidgetType", "canonicalReference": "obsidian-typings!PropertyWidgetType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "widget", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!PropertyWidgetType:type", "docComment": "/**\n * Property widget type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type PropertyWidgetType =\n " }, { "kind": "Content", "text": "| 'aliases'\n | 'checkbox'\n | 'date'\n | 'datetime'\n | 'multitext'\n | 'number'\n | 'tags'\n | 'text'\n | string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/PropertyWidgetType.d.ts", "releaseTag": "Public", "name": "PropertyWidgetType", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PublishPlugin:interface", "docComment": "/**\n * Internal plugin registration for the Obsidian Publish feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PublishPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PublishPluginInstance", "canonicalReference": "obsidian-typings!PublishPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/publish/PublishPlugin.d.ts", "releaseTag": "Public", "name": "PublishPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!PublishPluginInstance:interface", "docComment": "/**\n * Plugin instance for Obsidian Publish, managing cloud publishing of vault content.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PublishPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PublishPlugin", "canonicalReference": "obsidian-typings!PublishPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/publish/PublishPluginInstance.d.ts", "releaseTag": "Public", "name": "PublishPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PublishPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!PublishPluginInstance#plugin:member", "docComment": "/**\n * Reference to the publish plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "PublishPlugin", "canonicalReference": "obsidian-typings!PublishPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!QueryForFuzzySearch:interface", "docComment": "/**\n * Query for fuzzy search.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface QueryForFuzzySearch " } ], "fileUrlPath": "src/obsidian/internals/QueryForFuzzySearch.d.ts", "releaseTag": "Public", "name": "QueryForFuzzySearch", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!QueryForFuzzySearch#fuzzy:member", "docComment": "/**\n * The fuzzy tokens of the query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fuzzy: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fuzzy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!QueryForFuzzySearch#query:member", "docComment": "/**\n * The query string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!QueryForFuzzySearch#tokens:member", "docComment": "/**\n * The tokens of the query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tokens: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokens", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RandomNotePlugin:interface", "docComment": "/**\n * Internal plugin registration for the random note feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RandomNotePlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RandomNotePluginInstance", "canonicalReference": "obsidian-typings!RandomNotePluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/random-note/RandomNotePlugin.d.ts", "releaseTag": "Public", "name": "RandomNotePlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RandomNotePluginInstance:interface", "docComment": "/**\n * Plugin instance for opening a random note from the vault.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RandomNotePluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RandomNotePlugin", "canonicalReference": "obsidian-typings!RandomNotePlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/random-note/RandomNotePluginInstance.d.ts", "releaseTag": "Public", "name": "RandomNotePluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RandomNotePluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RangeSetUpdate:interface", "docComment": "/**\n * Configuration passed to {@link @codemirror/state#RangeSet.update}.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RangeSetUpdate<T extends " }, { "kind": "Reference", "text": "RangeValue", "canonicalReference": "@codemirror/state!RangeValue:class" }, { "kind": "Content", "text": "> " } ], "fileUrlPath": "src/@codemirror__state/internals/RangeSetUpdate.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "RangeSetUpdate", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RangeSetUpdate#add:member", "docComment": "/**\n * An array of ranges to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add?: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "CmRange", "canonicalReference": "obsidian-typings!CmRange:interface" }, { "kind": "Content", "text": "<T>[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "add", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RangeSetUpdate#filter:member(1)", "docComment": "/**\n * A filter function that determines which existing ranges to keep.\n *\n * @param from - The start of the range.\n *\n * @param to - The end of the range.\n *\n * @param value - The range value.\n *\n * @returns Whether to keep the range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filter?(from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "filter" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RangeSetUpdate#filterFrom:member", "docComment": "/**\n * The start of the range to filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filterFrom?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filterFrom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RangeSetUpdate#filterTo:member", "docComment": "/**\n * The end of the range to filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filterTo?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filterTo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RangeSetUpdate#sort:member", "docComment": "/**\n * Whether to sort the ranges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sort?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sort", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ReadViewRenderer:interface", "docComment": "/**\n * Renderer for the reading/preview view, managing section-based markdown rendering.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ReadViewRenderer " } ], "fileUrlPath": "src/obsidian/internals/ReadViewRenderer.d.ts", "releaseTag": "Public", "name": "ReadViewRenderer", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#addBottomPadding:member", "docComment": "/**\n * Whether to add bottom padding to the preview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addBottomPadding: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "addBottomPadding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#asyncSections:member", "docComment": "/**\n * Sections that are being rendered asynchronously.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "asyncSections: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "asyncSections", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#clear:member(1)", "docComment": "/**\n * Clear all rendered sections and reset the renderer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#lastRender:member", "docComment": "/**\n * Timestamp of the last render operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastRender: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastRender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#lastScroll:member", "docComment": "/**\n * Last recorded scroll position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastScroll: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastScroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#lastText:member", "docComment": "/**\n * Text content from the last render.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#parseAsync:member(1)", "docComment": "/**\n * Parse the text content asynchronously into sections.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parseAsync(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "parseAsync" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#parseSync:member(1)", "docComment": "/**\n * Parse the text content synchronously into sections.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parseSync(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "parseSync" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#previewEl:member", "docComment": "/**\n * Container element for the rendered preview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "previewEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "previewEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#pusherEl:member", "docComment": "/**\n * Element used to push content for scroll height calculation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pusherEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pusherEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#queueRender:member(1)", "docComment": "/**\n * Queue a render update for the next animation frame.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queueRender(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "queueRender" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#recycledSections:member", "docComment": "/**\n * Pool of recycled section elements for reuse.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "recycledSections: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "recycledSections", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#rendered:member", "docComment": "/**\n * Currently rendered section data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rendered: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rendered", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#sections:member", "docComment": "/**\n * All sections in the rendered document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sections: " }, { "kind": "Reference", "text": "RendererSection", "canonicalReference": "obsidian-typings!RendererSection:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sections", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#set:member(1)", "docComment": "/**\n * Set the text content and trigger a re-render.\n *\n * @param text - The text content to render.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "set(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "set" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReadViewRenderer#text:member", "docComment": "/**\n * Current text content being rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RecentFileTracker:interface", "docComment": "/**\n * Tracks recently opened files for quick access and navigation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RecentFileTracker " } ], "fileUrlPath": "src/obsidian/internals/RecentFileTracker.d.ts", "releaseTag": "Public", "name": "RecentFileTracker", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#addRecentFile:member(1)", "docComment": "/**\n * Add a file to the recent files list, if the workspace layout is ready.\n *\n * @param file - The file to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addRecentFile(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addRecentFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#collect:member(1)", "docComment": "/**\n * Add a file to the recent files list.\n *\n * @param file - File to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collect(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "collect" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getRecentFileTrackerConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param workspace - The workspace.\n *\n * @param vault - The vault.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(workspace: " }, { "kind": "Reference", "text": "Workspace", "canonicalReference": "obsidian!Workspace:class" }, { "kind": "Content", "text": ", vault: " }, { "kind": "Reference", "text": "Vault", "canonicalReference": "obsidian-typings!~Vault" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "workspace", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "vault", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#getLastOpenFiles:member(1)", "docComment": "/**\n * Returns the last 10 opened files.\n *\n * @returns Array of file paths.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getLastOpenFiles(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLastOpenFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#getRecentFiles:member(1)", "docComment": "/**\n * Get last n files of type (defaults to 10).\n *\n * @param options - Options for filtering recent files.\n *\n * @returns Array of file paths.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRecentFiles(options?: " }, { "kind": "Reference", "text": "GetRecentFilesOptions", "canonicalReference": "obsidian-typings!GetRecentFilesOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "getRecentFiles" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RecentFileTracker#lastOpenFiles:member", "docComment": "/**\n * List of last opened file paths, limited to 50.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastOpenFiles: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastOpenFiles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#load:member(1)", "docComment": "/**\n * Set the last opened files.\n *\n * @param savedFiles - Array of file paths to load.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "load(savedFiles: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "savedFiles", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "load" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#onFileCreated:member(1)", "docComment": "/**\n * On file create, save file to last opened files.\n *\n * @param file - The created file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileCreated(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onFileCreated" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#onFileOpen:member(1)", "docComment": "/**\n * On file open, save file to last opened files.\n *\n * @param prevFile - Previously opened file.\n *\n * @param file - Newly opened file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileOpen(prevFile: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "prevFile", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onFileOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#onRename:member(1)", "docComment": "/**\n * On file rename, update file path in last opened files.\n *\n * @param file - The renamed file.\n *\n * @param oldPath - Previous file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRename(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", oldPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "oldPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RecentFileTracker#serialize:member(1)", "docComment": "/**\n * Get last opened files.\n *\n * @returns Array of file paths.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialize(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "serialize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RecentFileTracker#vault:member", "docComment": "/**\n * Reference to the {@link obsidian#Vault}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vault: " }, { "kind": "Reference", "text": "Vault", "canonicalReference": "obsidian-typings!~Vault" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vault", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RecentFileTracker#workspace:member", "docComment": "/**\n * Reference to the {@link obsidian#Workspace}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workspace: " }, { "kind": "Reference", "text": "Workspace", "canonicalReference": "obsidian!Workspace:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "workspace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RegisterExternalDiagramsOptions:interface", "docComment": "/**\n * Options for registering external diagram definitions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RegisterExternalDiagramsOptions " } ], "fileUrlPath": "src/mermaid/internals/RegisterExternalDiagramsOptions.d.ts", "releaseTag": "Public", "name": "RegisterExternalDiagramsOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RegisterExternalDiagramsOptions#lazyLoad:member", "docComment": "/**\n * Whether to lazily load the diagram definitions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lazyLoad?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lazyLoad", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!registerGlobalHelper:function(1)", "docComment": "/**\n * Registers a global helper with a predicate.\n *\n * @param type - The helper type.\n *\n * @param name - The helper name.\n *\n * @param predicate - A predicate function to determine applicability.\n *\n * @param value - The helper implementation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function registerGlobalHelper(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", predicate: " }, { "kind": "Content", "text": "(mode: " }, { "kind": "Reference", "text": "Cm5Mode", "canonicalReference": "obsidian-typings!Cm5Mode:interface" }, { "kind": "Content", "text": "<unknown>, cm: " }, { "kind": "Reference", "text": "Cm5Editor", "canonicalReference": "obsidian-typings!Cm5Editor:interface" }, { "kind": "Content", "text": ") => boolean" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/registerGlobalHelper.d.ts", "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "predicate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 10 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false } ], "name": "registerGlobalHelper" }, { "kind": "Function", "canonicalReference": "obsidian-typings!registerHelper:function(1)", "docComment": "/**\n * Registers a helper value for a specific type.\n *\n * @param type - The helper type.\n *\n * @param name - The helper name.\n *\n * @param value - The helper implementation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function registerHelper(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/registerHelper.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "registerHelper" }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!RegisterPlugin:type", "docComment": "/**\n * Plugin registration function.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type RegisterPlugin = " }, { "kind": "Content", "text": "<T>(pluginName: string, implementations?: " }, { "kind": "Reference", "text": "Readonly", "canonicalReference": "!Readonly:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PluginImplementations", "canonicalReference": "obsidian-typings!PluginImplementations:interface" }, { "kind": "Content", "text": ">) => T" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/@capacitor__core/internals/RegisterPlugin.d.ts", "releaseTag": "Public", "name": "RegisterPlugin", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ReleaseNotesView:interface", "docComment": "/**\n * View for displaying Obsidian release notes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ReleaseNotesView extends " }, { "kind": "Reference", "text": "ItemView", "canonicalReference": "obsidian!ItemView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/ReleaseNotesView.d.ts", "releaseTag": "Public", "name": "ReleaseNotesView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReleaseNotesView#fetchReleaseNotes:member(1)", "docComment": "/**\n * Get the release notes from GitHub.\n *\n * @param version - The version of the release notes.\n *\n * @returns The fetched release notes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fetchReleaseNotes(version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "version", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "fetchReleaseNotes" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReleaseNotesView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The view type identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.ReleaseNotes", "canonicalReference": "obsidian-typings!~__type#ReleaseNotes:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReleaseNotesView#render:member(1)", "docComment": "/**\n * Renders the release notes.\n *\n * @returns The result of the rendering operation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ReleaseNotesView#showPatchNotes:member(1)", "docComment": "/**\n * Display the patch notes for a specific version.\n *\n * @param e - The event or trigger.\n *\n * @param version - The version to display patch notes for.\n *\n * @returns The result of rendering the patch notes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showPatchNotes(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "version", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "showPatchNotes" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!reloadResources:var", "docComment": "/**\n * Reloads resources for the given languages and namespaces.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reloadResources: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['reloadResources']" } ], "fileUrlPath": "src/i18next/internals/functions/reloadResources.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "reloadResources", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Variable", "canonicalReference": "obsidian-typings!remote:var", "docComment": "/**\n * Electron remote module instance for accessing main process modules.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remote: " }, { "kind": "Reference", "text": "ElectronRemote", "canonicalReference": "obsidian-typings!ElectronRemote:interface" } ], "fileUrlPath": "src/electron/internals/vars/remote.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "remote", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RendererSection:interface", "docComment": "/**\n * A section of the read view renderer representing a block of rendered content.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RendererSection " } ], "fileUrlPath": "src/obsidian/internals/RendererSection.d.ts", "releaseTag": "Public", "name": "RendererSection", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RendererSection#el:member", "docComment": "/**\n * DOM element for this section.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "el", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RendererSection#html:member", "docComment": "/**\n * Raw HTML content for this section.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "html: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "html", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RendererSection#rendered:member", "docComment": "/**\n * Whether this section has been rendered to the DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rendered: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rendered", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RenderParameters:interface", "docComment": "/**\n * Parameters for rendering a PDF page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RenderParameters " } ], "fileUrlPath": "src/pdfjs-dist/internals/RenderParameters.d.ts", "releaseTag": "Public", "name": "RenderParameters", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RenderParameters#background:member", "docComment": "/**\n * Background color for the canvas.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "background?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "background", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RenderParameters#canvasContext:member", "docComment": "/**\n * The 2D canvas rendering context to draw on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvasContext: " }, { "kind": "Reference", "text": "CanvasRenderingContext2D", "canonicalReference": "!CanvasRenderingContext2D:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvasContext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RenderParameters#intent:member", "docComment": "/**\n * Rendering intent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "intent?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "intent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RenderParameters#transform:member", "docComment": "/**\n * Additional transform matrix.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transform?: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "transform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RenderParameters#viewport:member", "docComment": "/**\n * The viewport to use for rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewport: " }, { "kind": "Reference", "text": "PageViewport", "canonicalReference": "obsidian-typings!PageViewport:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RenderResult:interface", "docComment": "/**\n * Result of rendering a Mermaid diagram.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RenderResult " } ], "fileUrlPath": "src/mermaid/internals/RenderResult.d.ts", "releaseTag": "Public", "name": "RenderResult", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RenderResult#bindFunctions:member(1)", "docComment": "/**\n * Bind interactive functions to the rendered element.\n *\n * @param element - The rendered SVG element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bindFunctions?(element: " }, { "kind": "Reference", "text": "Element", "canonicalReference": "!Element:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "bindFunctions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RenderResult#svg:member", "docComment": "/**\n * The rendered SVG string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "svg: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "svg", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RenderTask:interface", "docComment": "/**\n * A task representing an ongoing page render operation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RenderTask " } ], "fileUrlPath": "src/pdfjs-dist/internals/RenderTask.d.ts", "releaseTag": "Public", "name": "RenderTask", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RenderTask#cancel:member(1)", "docComment": "/**\n * Cancels the render task.\n *\n * @param extraDelay - Optional extra delay before cancellation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel(extraDelay?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extraDelay", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "cancel" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RenderTask#onContinue:member(1)", "docComment": "/**\n * Callback invoked to allow continuation of rendering.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onContinue?(cont: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cont", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onContinue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RenderTask#promise:member", "docComment": "/**\n * Promise that resolves when rendering is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "promise: " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "promise", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ReplaceDecorationSpec:interface", "docComment": "/**\n * Specification for a replace decoration that replaces a range of text.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ReplaceDecorationSpec " } ], "fileUrlPath": "src/@codemirror__view/internals/ReplaceDecorationSpec.d.ts", "releaseTag": "Public", "name": "ReplaceDecorationSpec", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReplaceDecorationSpec#block:member", "docComment": "/**\n * Whether this is a block replacement.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "block?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "block", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReplaceDecorationSpec#inclusive:member", "docComment": "/**\n * Whether both sides of the replacement are inclusive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inclusive?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inclusive", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReplaceDecorationSpec#inclusiveEnd:member", "docComment": "/**\n * Whether the end of the replacement is inclusive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inclusiveEnd?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inclusiveEnd", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReplaceDecorationSpec#inclusiveStart:member", "docComment": "/**\n * Whether the start of the replacement is inclusive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inclusiveStart?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "inclusiveStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ReplaceDecorationSpec#widget:member", "docComment": "/**\n * Optional widget to display in place of the replaced text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "widget?: " }, { "kind": "Reference", "text": "WidgetType", "canonicalReference": "@codemirror/view!WidgetType:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "widget", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ResourceStore:interface", "docComment": "/**\n * Store for managing i18next translation resources.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResourceStore " } ], "fileUrlPath": "src/i18next/internals/ResourceStore.d.ts", "releaseTag": "Public", "name": "ResourceStore", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#addNamespaces:member(1)", "docComment": "/**\n * Adds namespaces to the store's options.\n *\n * @param ns - Namespace or namespaces to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addNamespaces(ns: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addNamespaces" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#addResource:member(1)", "docComment": "/**\n * Adds a single resource entry.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @param key - Resource key.\n *\n * @param value - Resource value.\n *\n * @param options - Additional options including `keySeparator` and `silent`.\n *\n * @returns The resource store instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addResource(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "AddResourceOptions", "canonicalReference": "obsidian-typings!AddResourceOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ResourceStore", "canonicalReference": "obsidian-typings!ResourceStore:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "name": "addResource" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#addResourceBundle:member(1)", "docComment": "/**\n * Adds a resource bundle to the store.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @param resources - Bundle of resources.\n *\n * @param deep - Whether to deep merge.\n *\n * @param overwrite - Whether to overwrite existing keys.\n *\n * @returns The resource store instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addResourceBundle(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", resources: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ", deep?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", overwrite?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ResourceStore", "canonicalReference": "obsidian-typings!ResourceStore:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "resources", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": false }, { "parameterName": "deep", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "isOptional": true }, { "parameterName": "overwrite", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "isOptional": true } ], "name": "addResourceBundle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#addResources:member(1)", "docComment": "/**\n * Adds multiple resource entries.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @param resources - Resource entries.\n *\n * @returns The resource store instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addResources(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", resources: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ResourceStore", "canonicalReference": "obsidian-typings!ResourceStore:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "resources", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": false } ], "name": "addResources" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResourceStore#data:member", "docComment": "/**\n * The underlying resource data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#getDataByLanguage:member(1)", "docComment": "/**\n * Gets all resource data for a language.\n *\n * @param lng - Language code.\n *\n * @returns The resource data or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getDataByLanguage(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>> | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getDataByLanguage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#getResource:member(1)", "docComment": "/**\n * Gets a single resource value.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @param key - Resource key.\n *\n * @param options - Additional options including `keySeparator`.\n *\n * @returns The resource value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getResource(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "GetResourceOptions", "canonicalReference": "obsidian-typings!GetResourceOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "getResource" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#getResourceBundle:member(1)", "docComment": "/**\n * Gets a resource bundle for a language and namespace.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @returns The resource bundle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getResourceBundle(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getResourceBundle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#hasResourceBundle:member(1)", "docComment": "/**\n * Checks whether a resource bundle exists.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @returns Whether the bundle exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasResourceBundle(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "hasResourceBundle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResourceStore#observers:member", "docComment": "/**\n * The registered event observers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "observers: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "observers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#off:member(1)", "docComment": "/**\n * Removes a listener for an event.\n *\n * @param event - Event name.\n *\n * @param listener - Listener function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener?: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#on:member(1)", "docComment": "/**\n * Registers a listener for an event.\n *\n * @param event - Event name.\n *\n * @param listener - Listener function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResourceStore#options:member", "docComment": "/**\n * The options used by this resource store.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "InitOptions", "canonicalReference": "obsidian-typings!InitOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#removeNamespaces:member(1)", "docComment": "/**\n * Removes namespaces from the store's options.\n *\n * @param ns - Namespace or namespaces to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeNamespaces(ns: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeNamespaces" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#removeResourceBundle:member(1)", "docComment": "/**\n * Removes a resource bundle.\n *\n * @param lng - Language code.\n *\n * @param ns - Namespace.\n *\n * @returns The resource store instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeResourceBundle(lng: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ns: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ResourceStore", "canonicalReference": "obsidian-typings!ResourceStore:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lng", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ns", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeResourceBundle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResourceStore#toJSON:member(1)", "docComment": "/**\n * Serializes the store's resource data.\n *\n * @returns The underlying resource data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toJSON(): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>>>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toJSON" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ResultDom:interface", "docComment": "/**\n * Container for search result DOM elements, managing the display of file search results.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultDom " } ], "fileUrlPath": "src/obsidian/internals/tree/ResultDom.d.ts", "releaseTag": "Public", "name": "ResultDom", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#addResult:member(1)", "docComment": "/**\n * Add a search result for a file to the result DOM.\n *\n * @param file - The file to add a result for.\n *\n * @param result - The search result data.\n *\n * @param content - The text content of the file.\n *\n * @param shouldShowTitle - Whether to show the file title.\n *\n * @returns The created result DOM item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addResult(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", result: " }, { "kind": "Reference", "text": "ResultDomResult", "canonicalReference": "obsidian-typings!ResultDomResult:interface" }, { "kind": "Content", "text": ", content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", shouldShowTitle?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ResultDomItem", "canonicalReference": "obsidian-typings!ResultDomItem:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "result", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "content", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "shouldShowTitle", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "addResult" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App} instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#changed:member", "docComment": "/**\n * Debounced callback triggered when results change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changed: " }, { "kind": "Reference", "text": "Debouncer", "canonicalReference": "obsidian!Debouncer:interface" }, { "kind": "Content", "text": "<[], unknown>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "changed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#changeFocusedItem:member(1)", "docComment": "/**\n * Change which result item has focus.\n *\n * @returns The result of changing the focused item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeFocusedItem(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "changeFocusedItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#childrenEl:member", "docComment": "/**\n * Container element for child result items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "childrenEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "childrenEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#collapseAll:member", "docComment": "/**\n * Whether all result items are collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapseAll: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapseAll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#el:member", "docComment": "/**\n * Root element of the result DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "el: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "el", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#emptyResults:member(1)", "docComment": "/**\n * Clear all search results from the DOM.\n *\n * @returns The result of clearing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "emptyResults(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "emptyResults" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#emptyStateEl:member", "docComment": "/**\n * Element displayed when there are no search results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "emptyStateEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "emptyStateEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#extraContext:member", "docComment": "/**\n * Whether extra surrounding context is shown around matches.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extraContext: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "extraContext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#focusedItem:member", "docComment": "/**\n * Currently focused result item, or `null` if none.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusedItem: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusedItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#getFiles:member(1)", "docComment": "/**\n * Get the list of files with search results.\n *\n * @returns The list of files with results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFiles(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#getMatchCount:member(1)", "docComment": "/**\n * Get the total number of matches across all results.\n *\n * @returns The total match count.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMatchCount(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getMatchCount" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#getResult:member(1)", "docComment": "/**\n * Get the result DOM item for a specific file.\n *\n * @returns The result DOM item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getResult(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getResult" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#infinityScroll:member", "docComment": "/**\n * Virtual scrolling component for rendering visible results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "infinityScroll: " }, { "kind": "Reference", "text": "InfinityScroll", "canonicalReference": "obsidian-typings!InfinityScroll:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "infinityScroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#info:member", "docComment": "/**\n * Layout information used by virtual scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "info: " }, { "kind": "Reference", "text": "TreeNodeInfo", "canonicalReference": "obsidian-typings!TreeNodeInfo:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "info", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#onChange:member(1)", "docComment": "/**\n * Callback invoked when the result set changes.\n *\n * @returns The result of the change handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onChange(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#onResize:member(1)", "docComment": "/**\n * Handle resize events and recalculate layout.\n *\n * @returns The result of the resize handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#pusherEl:member", "docComment": "/**\n * Spacer element used to maintain correct scroll height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pusherEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pusherEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#removeResult:member(1)", "docComment": "/**\n * Remove a search result from the DOM.\n *\n * @returns The result of the removal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeResult(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeResult" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#resultDomLookup:member", "docComment": "/**\n * Lookup map from file to its corresponding result DOM item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resultDomLookup: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ResultDomItem", "canonicalReference": "obsidian-typings!ResultDomItem:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resultDomLookup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#setCollapseAll:member(1)", "docComment": "/**\n * Set whether all result items should be collapsed.\n *\n * @returns The result of setting collapse state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapseAll(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setCollapseAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#setExtraContext:member(1)", "docComment": "/**\n * Set whether extra context is shown around matches.\n *\n * @returns The result of setting extra context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setExtraContext(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setExtraContext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#setFocusedItem:member(1)", "docComment": "/**\n * Set the focused result item.\n *\n * @returns The result of setting the focused item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFocusedItem(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setFocusedItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#showingEmptyState:member", "docComment": "/**\n * Whether the empty state placeholder is currently displayed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showingEmptyState: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showingEmptyState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#sortOrder:member", "docComment": "/**\n * Current sort order for search results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sortOrder: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sortOrder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#startLoader:member(1)", "docComment": "/**\n * Show a loading indicator while search is in progress.\n *\n * @returns The result of starting the loader.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startLoader(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "startLoader" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#stopLoader:member(1)", "docComment": "/**\n * Hide the loading indicator when search completes.\n *\n * @returns The result of stopping the loader.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopLoader(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopLoader" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDom#toggle:member(1)", "docComment": "/**\n * Toggle the collapsed state of a result item.\n *\n * @returns The result of toggling the collapse state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggle(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "toggle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#vChildren:member", "docComment": "/**\n * Virtual children manager for result items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vChildren: " }, { "kind": "Reference", "text": "TreeNodeVChildren", "canonicalReference": "obsidian-typings!TreeNodeVChildren:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ResultDomItem", "canonicalReference": "obsidian-typings!ResultDomItem:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ResultDom", "canonicalReference": "obsidian-typings!ResultDom:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vChildren", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDom#working:member", "docComment": "/**\n * Whether a search operation is currently in progress.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "working: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "working", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ResultDomItem:interface", "docComment": "/**\n * Represents a single file's search result in the result DOM tree.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultDomItem extends " }, { "kind": "Reference", "text": "TreeNode", "canonicalReference": "obsidian-typings!TreeNode:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/tree/ResultDomItem.d.ts", "releaseTag": "Public", "name": "ResultDomItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App} instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#childrenEl:member", "docComment": "/**\n * Container element for child match items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "childrenEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "childrenEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#collapsed:member", "docComment": "/**\n * Whether this result item is currently collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#collapseEl:member", "docComment": "/**\n * Element for the collapse/expand toggle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapseEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapseEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#collapsible:member", "docComment": "/**\n * Whether this result item can be collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapsible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapsible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#containerEl:member", "docComment": "/**\n * Outer container element for this result item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#content:member", "docComment": "/**\n * Text content of the file associated with this result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#extraContext:member", "docComment": "/**\n * Whether extra surrounding context is shown around matches.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "extraContext: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "extraContext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#file:member", "docComment": "/**\n * The file associated with this search result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#getMatchExtraPositions:member(1)", "docComment": "/**\n * Get additional context positions surrounding a match.\n *\n * @returns The extra context positions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getMatchExtraPositions(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "getMatchExtraPositions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#info:member", "docComment": "/**\n * Layout information used by virtual scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "info: " }, { "kind": "Reference", "text": "TreeNodeInfo", "canonicalReference": "obsidian-typings!TreeNodeInfo:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "info", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#invalidate:member(1)", "docComment": "/**\n * Mark this result item as needing re-render.\n *\n * @returns The result of the invalidation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "invalidate(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "invalidate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#onCollapseClick:member(1)", "docComment": "/**\n * Handle click on the collapse toggle.\n *\n * @returns The result of the click handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCollapseClick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onCollapseClick" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#onMatchRender:member", "docComment": "/**\n * Callback for custom match rendering, or `null` if not set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMatchRender: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onMatchRender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#onResultClick:member(1)", "docComment": "/**\n * Handle click on a search result to navigate to it.\n *\n * @returns The result of the click handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResultClick(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onResultClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#onResultContextMenu:member(1)", "docComment": "/**\n * Handle right-click context menu on a search result.\n *\n * @returns The result of the context menu handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResultContextMenu(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onResultContextMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#onResultMouseover:member(1)", "docComment": "/**\n * Handle mouseover on a search result for preview.\n *\n * @returns The result of the mouseover handler.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResultMouseover(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg3: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "arg3", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onResultMouseover" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#parent:member", "docComment": "/**\n * Parent result DOM container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent: " }, { "kind": "Reference", "text": "ResultDom", "canonicalReference": "obsidian-typings!ResultDom:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#parentDom:member", "docComment": "/**\n * Reference to the parent result DOM container.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parentDom: " }, { "kind": "Reference", "text": "ResultDom", "canonicalReference": "obsidian-typings!ResultDom:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parentDom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#pusherEl:member", "docComment": "/**\n * Spacer element used to maintain correct scroll height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pusherEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pusherEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#renderContentMatches:member(1)", "docComment": "/**\n * Render the content matches for this result item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderContentMatches(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "renderContentMatches" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#result:member", "docComment": "/**\n * Search result data containing match positions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "result: " }, { "kind": "Reference", "text": "ResultDomResult", "canonicalReference": "obsidian-typings!ResultDomResult:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "result", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#separateMatches:member", "docComment": "/**\n * Whether matches are displayed as separate items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "separateMatches: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "separateMatches", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#setCollapse:member(1)", "docComment": "/**\n * Set the collapsed state of this result item.\n *\n * @returns Resolves when the collapse state has been applied.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapse(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", arg2: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arg2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setCollapse" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#setCollapsible:member(1)", "docComment": "/**\n * Set whether this result item can be collapsed.\n *\n * @returns The result of setting the collapsible state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapsible(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setCollapsible" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItem#setExtraContext:member(1)", "docComment": "/**\n * Set whether extra context is shown around matches.\n *\n * @returns The result of setting extra context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setExtraContext(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setExtraContext" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#showTitle:member", "docComment": "/**\n * Whether the file title is shown above matches.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showTitle: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItem#vChildren:member", "docComment": "/**\n * Virtual children manager for match child items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vChildren: " }, { "kind": "Reference", "text": "TreeNodeVChildren", "canonicalReference": "obsidian-typings!TreeNodeVChildren:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ResultDomItem", "canonicalReference": "obsidian-typings!ResultDomItem:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ResultDomItemChild", "canonicalReference": "obsidian-typings!ResultDomItemChild:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vChildren", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ResultDomItemChild:interface", "docComment": "/**\n * Represents an individual match segment within a search result item.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultDomItemChild extends " }, { "kind": "Reference", "text": "TreeNode", "canonicalReference": "obsidian-typings!TreeNode:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/tree/ResultDomItemChild.d.ts", "releaseTag": "Public", "name": "ResultDomItemChild", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#cache:member", "docComment": "/**\n * Cached metadata for the file containing this match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cache: " }, { "kind": "Reference", "text": "CachedMetadata", "canonicalReference": "obsidian!CachedMetadata:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cache", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#content:member", "docComment": "/**\n * Text content of the matched region.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#end:member", "docComment": "/**\n * End offset of the match context within the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "end: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "end", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#getNextPos:member(1)", "docComment": "/**\n * Get the position of the next match.\n *\n * @returns The next match position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNextPos(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getNextPos" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#getPrevPos:member(1)", "docComment": "/**\n * Get the position of the previous match.\n *\n * @returns The previous match position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPrevPos(arg1: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "arg1", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getPrevPos" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#info:member", "docComment": "/**\n * Layout information used by virtual scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "info: " }, { "kind": "Reference", "text": "TreeNodeInfo", "canonicalReference": "obsidian-typings!TreeNodeInfo:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "info", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#matches:member", "docComment": "/**\n * Array of match positions within the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "matches: " }, { "kind": "Reference", "text": "ContentPosition", "canonicalReference": "obsidian-typings!ContentPosition:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "matches", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#mutateEState:member", "docComment": "/**\n * Callback to mutate the editor state when navigating to this match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mutateEState: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mutateEState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#onFocusEnter:member(1)", "docComment": "/**\n * Handle focus entering this match item.\n *\n * @param event - The UI event that triggered focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocusEnter(event?: " }, { "kind": "Reference", "text": "UIEvent", "canonicalReference": "!UIEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "onFocusEnter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#onFocusExit:member(1)", "docComment": "/**\n * Handle focus leaving this match item.\n *\n * @param event - The UI event that triggered focus exit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocusExit(event?: " }, { "kind": "Reference", "text": "UIEvent", "canonicalReference": "!UIEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "onFocusExit" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#onMatchRender:member", "docComment": "/**\n * Callback for custom rendering of match highlights.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMatchRender: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onMatchRender", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#onResultClick:member(1)", "docComment": "/**\n * Handle click on this match to navigate to it.\n *\n * @param event - The UI event that triggered the click.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResultClick(event: " }, { "kind": "Reference", "text": "UIEvent", "canonicalReference": "!UIEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onResultClick" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#parent:member", "docComment": "/**\n * Parent result item containing this match child.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent: " }, { "kind": "Reference", "text": "ResultDomItem", "canonicalReference": "obsidian-typings!ResultDomItem:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#parentDom:member", "docComment": "/**\n * Reference to the parent result item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parentDom: " }, { "kind": "Reference", "text": "ResultDomItem", "canonicalReference": "obsidian-typings!ResultDomItem:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parentDom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#render:member(1)", "docComment": "/**\n * Render this match with optional surrounding text indicators.\n *\n * @param hasTextBefore - Whether there is text before this match.\n *\n * @param hasTextAfter - Whether there is text after this match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(hasTextBefore: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", hasTextAfter: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "hasTextBefore", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "hasTextAfter", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#showMoreAfter:member(1)", "docComment": "/**\n * Expand the context to show more text after the match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMoreAfter(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showMoreAfter" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#showMoreAfterEl:member", "docComment": "/**\n * Element for the \"show more context after\" button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMoreAfterEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showMoreAfterEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#showMoreBefore:member(1)", "docComment": "/**\n * Expand the context to show more text before the match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMoreBefore(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showMoreBefore" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#showMoreBeforeEl:member", "docComment": "/**\n * Element for the \"show more context before\" button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showMoreBeforeEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showMoreBeforeEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#start:member", "docComment": "/**\n * Start offset of the match context within the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "start", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ResultDomItemChild#toggleShowMoreContextButtons:member(1)", "docComment": "/**\n * Toggle visibility of the \"show more context\" buttons.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleShowMoreContextButtons(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleShowMoreContextButtons" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ResultDomResult:interface", "docComment": "/**\n * Search result data containing matched content positions and property matches.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultDomResult " } ], "fileUrlPath": "src/obsidian/internals/tree/ResultDomResult.d.ts", "releaseTag": "Public", "name": "ResultDomResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomResult#content:member", "docComment": "/**\n * Array of content match positions within the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Reference", "text": "ContentPosition", "canonicalReference": "obsidian-typings!ContentPosition:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultDomResult#properties:member", "docComment": "/**\n * Array of matched property results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "properties: " }, { "kind": "Reference", "text": "ResultProperty", "canonicalReference": "obsidian-typings!ResultProperty:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ResultProperty:interface", "docComment": "/**\n * Represents a matched property within a search result.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultProperty " } ], "fileUrlPath": "src/obsidian/internals/tree/ResultProperty.d.ts", "releaseTag": "Public", "name": "ResultProperty", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultProperty#key:member", "docComment": "/**\n * Property key name that was matched.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultProperty#pos:member", "docComment": "/**\n * {@link Position} of the match within the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pos: " }, { "kind": "Reference", "text": "ContentPosition", "canonicalReference": "obsidian-typings!ContentPosition:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pos", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ResultProperty#subkey:member", "docComment": "/**\n * Path of sub-keys for nested property matches.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subkey: " }, { "kind": "Content", "text": "(number | string)[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subkey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RibbonItem:interface", "docComment": "/**\n * Represents a button item in the sidebar ribbon.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RibbonItem " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/RibbonItem.d.ts", "releaseTag": "Public", "name": "RibbonItem", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RibbonItem#callback:member(1)", "docComment": "/**\n * Callback invoked when this ribbon item is clicked.\n *\n * @returns A promise that resolves when the callback completes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "callback(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "callback" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RibbonItem#hidden:member", "docComment": "/**\n * Whether this ribbon item is hidden.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hidden: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hidden", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RibbonItem#icon:member", "docComment": "/**\n * Icon name displayed for this ribbon item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Reference", "text": "IconName", "canonicalReference": "obsidian!IconName:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RibbonItem#id:member", "docComment": "/**\n * Unique identifier for this ribbon item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RibbonItem#title:member", "docComment": "/**\n * Tooltip title displayed on hover.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RoundFunction:interface", "docComment": "/**\n * Function `Round`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RoundFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/RoundFunction.d.ts", "releaseTag": "Public", "name": "RoundFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Runnable:interface", "docComment": "/**\n * A controllable task with start, stop, and cancel lifecycle.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Runnable " } ], "fileUrlPath": "src/obsidian/internals/Runnable.d.ts", "releaseTag": "Public", "name": "Runnable", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Runnable#cancel:member(1)", "docComment": "/**\n * Cancel the runnable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cancel" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Runnable#cancelled:member", "docComment": "/**\n * Whether the runnable has been cancelled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancelled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cancelled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Runnable#isCancelled:member(1)", "docComment": "/**\n * Check whether the runnable has been cancelled.\n *\n * @returns Whether the runnable has been cancelled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isCancelled(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isCancelled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Runnable#isRunning:member(1)", "docComment": "/**\n * Check whether the runnable is currently running.\n *\n * @returns Whether the runnable is currently running.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isRunning(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isRunning" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Runnable#onCancel:member", "docComment": "/**\n * Callback invoked when the runnable is cancelled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCancel: " }, { "kind": "Content", "text": "(() => void) | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onCancel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Runnable#onStart:member", "docComment": "/**\n * Callback invoked when the runnable starts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onStart: " }, { "kind": "Content", "text": "(() => void) | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Runnable#onStop:member", "docComment": "/**\n * Callback invoked when the runnable stops.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onStop: " }, { "kind": "Content", "text": "(() => void) | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "onStop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Runnable#running:member", "docComment": "/**\n * Whether the runnable is currently running.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "running: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "running", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Runnable#start:member(1)", "docComment": "/**\n * Start the runnable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "start" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Runnable#stop:member(1)", "docComment": "/**\n * Stop the runnable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stop(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stop" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!RunOptions:interface", "docComment": "/**\n * Options for running Mermaid rendering on existing DOM elements.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RunOptions " } ], "fileUrlPath": "src/mermaid/internals/RunOptions.d.ts", "releaseTag": "Public", "name": "RunOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RunOptions#nodes:member", "docComment": "/**\n * DOM nodes to render.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodes?: " }, { "kind": "Reference", "text": "ArrayLike", "canonicalReference": "!ArrayLike:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nodes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!RunOptions#postRenderCallback:member(1)", "docComment": "/**\n * Callback invoked after each diagram is rendered.\n *\n * @param id - The ID of the rendered diagram.\n *\n * @returns The callback result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postRenderCallback?(id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "postRenderCallback" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RunOptions#querySelector:member", "docComment": "/**\n * CSS selector for elements to render.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "querySelector?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "querySelector", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!RunOptions#suppressErrors:member", "docComment": "/**\n * Whether to suppress rendering errors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suppressErrors?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "suppressErrors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ScrollInfo:interface", "docComment": "/**\n * Information about the editor's scroll position and dimensions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ScrollInfo " } ], "fileUrlPath": "src/@codemirror__view/internals/ScrollInfo.d.ts", "releaseTag": "Public", "name": "ScrollInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ScrollInfo#clientHeight:member", "docComment": "/**\n * Visible height of the scrollable area (viewport height).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clientHeight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clientHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ScrollInfo#clientWidth:member", "docComment": "/**\n * Visible width of the scrollable area (viewport width).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clientWidth: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clientWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ScrollInfo#height:member", "docComment": "/**\n * Total scrollable height of the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ScrollInfo#left:member", "docComment": "/**\n * Horizontal scroll offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ScrollInfo#top:member", "docComment": "/**\n * Vertical scroll offset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ScrollInfo#width:member", "docComment": "/**\n * Total scrollable width of the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "obsidian-typings!scrypt:function(1)", "docComment": "/**\n * Derive a key using the scrypt key derivation function.\n *\n * @param password - The password to derive from.\n *\n * @param salt - The salt value.\n *\n * @param N - CPU/memory cost parameter.\n *\n * @param r - Block size parameter.\n *\n * @param p - Parallelization parameter.\n *\n * @param dkLen - Desired key length in bytes.\n *\n * @param callback - Optional progress callback.\n *\n * @returns A promise that resolves to the derived key.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function scrypt(\n password: " }, { "kind": "Reference", "text": "ArrayLike", "canonicalReference": "!ArrayLike:interface" }, { "kind": "Content", "text": "<number>" }, { "kind": "Content", "text": ",\n salt: " }, { "kind": "Reference", "text": "ArrayLike", "canonicalReference": "!ArrayLike:interface" }, { "kind": "Content", "text": "<number>" }, { "kind": "Content", "text": ",\n N: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ",\n r: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ",\n p: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ",\n dkLen: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ",\n callback?: " }, { "kind": "Reference", "text": "ProgressCallback", "canonicalReference": "obsidian-typings!ProgressCallback:type" }, { "kind": "Content", "text": "\n): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Uint8Array", "canonicalReference": "!Uint8Array:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/scrypt-js/internals/functions/scrypt.d.ts", "returnTypeTokenRange": { "startIndex": 17, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "password", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "salt", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 }, "isOptional": false }, { "parameterName": "N", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "r", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "p", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false }, { "parameterName": "dkLen", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "isOptional": true } ], "name": "scrypt" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SearchBookmarkItem:interface", "docComment": "/**\n * {@link Bookmark} item representing a saved search query.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SearchBookmarkItem extends " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/bookmark-items/SearchBookmarkItem.d.ts", "releaseTag": "Public", "name": "SearchBookmarkItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchBookmarkItem#query:member", "docComment": "/**\n * The saved search query string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchBookmarkItem#type:member", "docComment": "/**\n * Discriminator indicating this is a search bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'search'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SearchCursor:interface", "docComment": "/**\n * Cursor for navigating through search results in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SearchCursor " } ], "fileUrlPath": "src/obsidian/internals/SearchCursor.d.ts", "releaseTag": "Public", "name": "SearchCursor", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchCursor#current:member(1)", "docComment": "/**\n * Current editor search position.\n *\n * @returns The current search position range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "current(): " }, { "kind": "Reference", "text": "EditorRange", "canonicalReference": "obsidian!EditorRange:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "current" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchCursor#findAll:member(1)", "docComment": "/**\n * All search results.\n *\n * @returns Array of all matching ranges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findAll(): " }, { "kind": "Reference", "text": "EditorRange", "canonicalReference": "obsidian!EditorRange:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchCursor#findNext:member(1)", "docComment": "/**\n * Next editor search position.\n *\n * @returns The next search position range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findNext(): " }, { "kind": "Reference", "text": "EditorRange", "canonicalReference": "obsidian!EditorRange:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findNext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchCursor#findPrevious:member(1)", "docComment": "/**\n * Previous editor search position.\n *\n * @returns The previous search position range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findPrevious(): " }, { "kind": "Reference", "text": "EditorRange", "canonicalReference": "obsidian!EditorRange:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "findPrevious" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchCursor#replace:member(1)", "docComment": "/**\n * Replace current search result with specified text.\n *\n * @param replacement - The text to replace with.\n *\n * @param origin - The origin identifier for the change.\n *\n * @remark\n *\n * origin is used by CodeMirror to determine which component was responsible for the change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replace(replacement: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", origin: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replacement", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "replace" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchCursor#replaceAll:member(1)", "docComment": "/**\n * Replace all search results with specified text.\n *\n * @param replacement - The text to replace with.\n *\n * @param origin - The origin identifier for the change.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replaceAll(replacement: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", origin: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "replacement", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "replaceAll" } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!SearchQuery:class", "docComment": "/**\n * Represents a search query with its configuration and methods for searching.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class SearchQuery " } ], "fileUrlPath": "src/@codemirror__search/internals/SearchQuery.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "SearchQuery", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!SearchQuery:constructor(1)", "docComment": "/**\n * Create new instance of {@link SearchQuery}\n *\n * @param config - Configuration\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(config: " }, { "kind": "Reference", "text": "SearchQueryConfig", "canonicalReference": "obsidian-typings!SearchQueryConfig:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!SearchQuery#caseSensitive:member", "docComment": "/**\n * Whether the search is case sensitive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly caseSensitive: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "caseSensitive", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!SearchQuery#eq:member(1)", "docComment": "/**\n * Check whether this query is equal to another.\n *\n * @param other - The other search query to compare with.\n *\n * @returns Whether the queries are equal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eq(other: " }, { "kind": "Reference", "text": "SearchQuery", "canonicalReference": "obsidian-typings!SearchQuery:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "other", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "eq" }, { "kind": "Method", "canonicalReference": "obsidian-typings!SearchQuery#getCursor:member(1)", "docComment": "/**\n * Get a cursor for iterating over matches.\n *\n * @param state - The text or editor state to search in.\n *\n * @param from - Optional start position.\n *\n * @param to - Optional end position.\n *\n * @returns An iterator over match ranges.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCursor(state: " }, { "kind": "Reference", "text": "CmText", "canonicalReference": "obsidian-typings!CmText:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "EditorState", "canonicalReference": "obsidian-typings!~EditorState" }, { "kind": "Content", "text": ", from?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", to?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Iterator", "canonicalReference": "!Iterator:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchQueryMatch", "canonicalReference": "obsidian-typings!SearchQueryMatch:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 13 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false }, { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "to", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "getCursor" }, { "kind": "Property", "canonicalReference": "obsidian-typings!SearchQuery#literal:member", "docComment": "/**\n * Whether the search string is treated as a literal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly literal: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "literal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!SearchQuery#regexp:member", "docComment": "/**\n * Whether the search string is a regular expression.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly regexp: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "regexp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!SearchQuery#replace:member", "docComment": "/**\n * The replacement string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly replace: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "replace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!SearchQuery#search:member", "docComment": "/**\n * The search string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly search: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "search", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!SearchQuery#valid:member", "docComment": "/**\n * Whether the search query is valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly valid: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "valid", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!SearchQuery#wholeWord:member", "docComment": "/**\n * Whether the search matches whole words only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly wholeWord: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "wholeWord", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SearchQueryConfig:interface", "docComment": "/**\n * Configuration for creating a search query.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SearchQueryConfig " } ], "fileUrlPath": "src/@codemirror__search/internals/SearchQueryConfig.d.ts", "releaseTag": "Public", "name": "SearchQueryConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchQueryConfig#caseSensitive:member", "docComment": "/**\n * Whether the search is case sensitive.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "caseSensitive?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "caseSensitive", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchQueryConfig#literal:member", "docComment": "/**\n * Whether the search string is treated as a literal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "literal?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "literal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchQueryConfig#regexp:member", "docComment": "/**\n * Whether the search string is a regular expression.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "regexp?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "regexp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchQueryConfig#replace:member", "docComment": "/**\n * The replacement string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replace?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "replace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchQueryConfig#search:member", "docComment": "/**\n * The search string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "search: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "search", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchQueryConfig#wholeWord:member", "docComment": "/**\n * Whether the search matches whole words only.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wholeWord?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "wholeWord", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SearchQueryMatch:interface", "docComment": "/**\n * A match result from a search query cursor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SearchQueryMatch " } ], "fileUrlPath": "src/@codemirror__search/internals/SearchQueryMatch.d.ts", "releaseTag": "Public", "name": "SearchQueryMatch", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchQueryMatch#from:member", "docComment": "/**\n * The start position of the match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SearchQueryMatch#to:member", "docComment": "/**\n * The end position of the match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SearchView:interface", "docComment": "/**\n * {@link obsidian#View} that displays the global search results pane.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SearchView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/global-search/SearchView.d.ts", "releaseTag": "Public", "name": "SearchView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#getQuery:member(1)", "docComment": "/**\n * Returns the value of the search element.\n *\n * @returns The current search query string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getQuery(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getQuery" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The search view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Search", "canonicalReference": "obsidian-typings!~__type#Search:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onCopyResultsClick:member(1)", "docComment": "/**\n * Handle the copy search results button click.\n *\n * @param event - The mouse click event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCopyResultsClick(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onCopyResultsClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onKeyArrowDownInFocus:member(1)", "docComment": "/**\n * Handle the down arrow key when a search result is focused.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyArrowDownInFocus(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyArrowDownInFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onKeyArrowLeftInFocus:member(1)", "docComment": "/**\n * Handle the left arrow key when a search result is focused.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyArrowLeftInFocus(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyArrowLeftInFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onKeyArrowRightInFocus:member(1)", "docComment": "/**\n * Handle the right arrow key when a search result is focused.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyArrowRightInFocus(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyArrowRightInFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onKeyArrowUpInFocus:member(1)", "docComment": "/**\n * Handle the up arrow key when a search result is focused.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyArrowUpInFocus(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyArrowUpInFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onKeyEnterInFocus:member(1)", "docComment": "/**\n * Handle the enter key when a search result is focused.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyEnterInFocus(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyEnterInFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onKeyShowMoreAfter:member(1)", "docComment": "/**\n * Show more context lines after a match.\n *\n * @param e - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyShowMoreAfter(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyShowMoreAfter" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onKeyShowMoreBefore:member(1)", "docComment": "/**\n * Show more context lines before a match.\n *\n * @param e - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyShowMoreBefore(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyShowMoreBefore" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#onTabHeaderClick:member(1)", "docComment": "/**\n * Called when the tap header is clicked. Brings this tab to the front.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTabHeaderClick(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onTabHeaderClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#renderSearchInfo:member(1)", "docComment": "/**\n * Render search metadata information into the given parent element.\n *\n * @param e - The search metadata to render.\n *\n * @param parentEl - The parent element to render into.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "renderSearchInfo(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", parentEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "parentEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "renderSearchInfo" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#saveSearch:member(1)", "docComment": "/**\n * Saves the current search string to the recent searches in Local Storage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#setCollapseAll:member(1)", "docComment": "/**\n * Set whether all search results are collapsed.\n *\n * @param e - Whether to collapse all results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapseAll(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setCollapseAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#setExplainSearch:member(1)", "docComment": "/**\n * Toggle the search query explanation display.\n *\n * @param e - Whether to show the query explanation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setExplainSearch(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setExplainSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#setExtraContext:member(1)", "docComment": "/**\n * Set whether extra context lines are shown around matches.\n *\n * @param e - Whether to show extra context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setExtraContext(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setExtraContext" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#setMatchingCase:member(1)", "docComment": "/**\n * Set whether the search is case-sensitive.\n *\n * @param e - Whether to match case.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setMatchingCase(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setMatchingCase" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#setQuery:member(1)", "docComment": "/**\n * Sets the value of the search element.\n *\n * @param value - The search string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setQuery(value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setQuery" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#setSortOrder:member(1)", "docComment": "/**\n * Set the sort order for search results.\n *\n * @param sortOrder - The sort order to apply.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSortOrder(sortOrder: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "sortOrder", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSortOrder" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#startSearch:member(1)", "docComment": "/**\n * Starts the search and renders the results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "startSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#stopSearch:member(1)", "docComment": "/**\n * Stops the search and clears the results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "stopSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SearchView#toggleFilterSection:member(1)", "docComment": "/**\n * Toggles the visibility of the filter section. Called if clicked on 'Search settings'.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleFilterSection(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleFilterSection" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SecondFunction:interface", "docComment": "/**\n * Function `Second`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SecondFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasExtract", "canonicalReference": "obsidian-typings!HasExtract:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/SecondFunction.d.ts", "releaseTag": "Public", "name": "SecondFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SerializedBasesSubView:interface", "docComment": "/**\n * Serialized bases sub view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializedBasesSubView " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/SerializedBasesSubView.d.ts", "releaseTag": "Public", "name": "SerializedBasesSubView", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedBasesSubView#name:member", "docComment": "/**\n * The name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedBasesSubView#type:member", "docComment": "/**\n * The type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SerializedWorkspace:interface", "docComment": "/**\n * Serialized representation of the full workspace layout and state.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializedWorkspace " } ], "fileUrlPath": "src/obsidian/internals/workspace/SerializedWorkspace.d.ts", "releaseTag": "Public", "name": "SerializedWorkspace", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspace#active:member", "docComment": "/**\n * Last active leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "active: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "active", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspace#lastOpenFiles:member", "docComment": "/**\n * Last opened files.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastOpenFiles: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastOpenFiles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspace#left:member", "docComment": "/**\n * Left opened leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Reference", "text": "LeafEntry", "canonicalReference": "obsidian-typings!LeafEntry:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspace#leftRibbon:member", "docComment": "/**\n * Left ribbon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "leftRibbon: " }, { "kind": "Reference", "text": "SerializedWorkspaceLeftRibbon", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeftRibbon:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "leftRibbon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspace#main:member", "docComment": "/**\n * Main (center) workspace leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "main: " }, { "kind": "Reference", "text": "LeafEntry", "canonicalReference": "obsidian-typings!LeafEntry:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "main", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspace#right:member", "docComment": "/**\n * Right opened leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "right: " }, { "kind": "Reference", "text": "LeafEntry", "canonicalReference": "obsidian-typings!LeafEntry:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SerializedWorkspaceItem:interface", "docComment": "/**\n * Serialized representation of a single workspace item (leaf, split, or tab group).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializedWorkspaceItem " } ], "fileUrlPath": "src/obsidian/internals/workspace/SerializedWorkspaceItem.d.ts", "releaseTag": "Public", "name": "SerializedWorkspaceItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspaceItem#dimension:member", "docComment": "/**\n * Size dimension of the workspace item (width or height depending on split direction).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dimension?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "dimension", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspaceItem#id:member", "docComment": "/**\n * Unique identifier of the workspace item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspaceItem#type:member", "docComment": "/**\n * Type of the workspace item (e.g., 'split', 'tabs', 'leaf').\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeafHistory:interface", "docComment": "/**\n * Serialized form of a workspace leaf's navigation history for persistence.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializedWorkspaceLeafHistory " } ], "fileUrlPath": "src/obsidian/internals/workspace-leaf-history/SerializedWorkspaceLeafHistory.d.ts", "releaseTag": "Public", "name": "SerializedWorkspaceLeafHistory", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeafHistory#backHistory:member", "docComment": "/**\n * List of previous navigation states.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backHistory: " }, { "kind": "Reference", "text": "WorkspaceLeafHistoryState", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeafHistory#forwardHistory:member", "docComment": "/**\n * List of forward navigation states (after going back).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forwardHistory: " }, { "kind": "Reference", "text": "WorkspaceLeafHistoryState", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "forwardHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeftRibbon:interface", "docComment": "/**\n * Serialized representation of the left ribbon bar state.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializedWorkspaceLeftRibbon " } ], "fileUrlPath": "src/obsidian/internals/workspace/SerializedWorkspaceLeftRibbon.d.ts", "releaseTag": "Public", "name": "SerializedWorkspaceLeftRibbon", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeftRibbon#hiddenItems:member", "docComment": "/**\n * Record of ribbon items and whether they are hidden.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hiddenItems: " }, { "kind": "Reference", "text": "SerializedWorkspaceLeftRibbonHiddenItemsRecord", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeftRibbonHiddenItemsRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hiddenItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeftRibbonHiddenItemsRecord:interface", "docComment": "/**\n * Record mapping ribbon item identifiers to their hidden state.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializedWorkspaceLeftRibbonHiddenItemsRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, boolean>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/workspace/SerializedWorkspaceLeftRibbonHiddenItemsRecord.d.ts", "releaseTag": "Public", "name": "SerializedWorkspaceLeftRibbonHiddenItemsRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SerializedWorkspaceSidedock:interface", "docComment": "/**\n * Serialized representation of a workspace sidedock (left or right sidebar).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializedWorkspaceSidedock extends " }, { "kind": "Reference", "text": "SerializedWorkspaceItem", "canonicalReference": "obsidian-typings!SerializedWorkspaceItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/workspace/SerializedWorkspaceSidedock.d.ts", "releaseTag": "Public", "name": "SerializedWorkspaceSidedock", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspaceSidedock#collapsed:member", "docComment": "/**\n * Whether the sidedock is collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SerializedWorkspaceSidedock#width:member", "docComment": "/**\n * Width of the sidedock in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Services:interface", "docComment": "/**\n * Container for i18next service instances.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Services " } ], "fileUrlPath": "src/i18next/internals/Services.d.ts", "releaseTag": "Public", "name": "Services", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!Services:index(1)", "docComment": "/**\n * Additional services.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Services#resourceStore:member", "docComment": "/**\n * The resource store service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceStore: " }, { "kind": "Reference", "text": "ResourceStore", "canonicalReference": "obsidian-typings!ResourceStore:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceStore", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Session:interface", "docComment": "/**\n * Electron session for managing browser sessions, cookies, cache, network, and extensions.\n *\n * Note: The upstream `static fromPartition(...)` and `static defaultSession` members cannot be expressed as statics on a plain interface, so they are modelled here as instance members.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Session " } ], "fileUrlPath": "src/electron/internals/Session.d.ts", "releaseTag": "Public", "name": "Session", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(1)", "docComment": "/**\n * Emitted after an extension is loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'extension-loaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(10)", "docComment": "/**\n * Emitted after a serial port has been removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'serial-port-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", port: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(11)", "docComment": "/**\n * Emitted when a hunspell dictionary file starts downloading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(12)", "docComment": "/**\n * Emitted when a hunspell dictionary file download fails.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-failure'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(13)", "docComment": "/**\n * Emitted when a hunspell dictionary file has been successfully downloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-success'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(14)", "docComment": "/**\n * Emitted when a hunspell dictionary file has been successfully initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-initialized'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(15)", "docComment": "/**\n * Emitted when Electron is about to download `item` in `webContents`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'will-download'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", item: " }, { "kind": "Reference", "text": "ElectronDownloadItem", "canonicalReference": "obsidian-typings!ElectronDownloadItem:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(2)", "docComment": "/**\n * Emitted after an extension is loaded and all necessary browser state is initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'extension-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(3)", "docComment": "/**\n * Emitted after an extension is unloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'extension-unloaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(4)", "docComment": "/**\n * Emitted when a new HID device becomes available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'hid-device-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronHidDeviceAddedDetails", "canonicalReference": "obsidian-typings!ElectronHidDeviceAddedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(5)", "docComment": "/**\n * Emitted when a HID device has been removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'hid-device-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronHidDeviceRemovedDetails", "canonicalReference": "obsidian-typings!ElectronHidDeviceRemovedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(6)", "docComment": "/**\n * Emitted when a render process requests preconnection to a URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'preconnect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preconnectUrl: string, allowCredentials: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(7)", "docComment": "/**\n * Emitted when a HID device needs to be selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'select-hid-device'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronSelectHidDeviceDetails", "canonicalReference": "obsidian-typings!ElectronSelectHidDeviceDetails:interface" }, { "kind": "Content", "text": ", callback: (deviceId?: null | string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(8)", "docComment": "/**\n * Emitted when a serial port needs to be selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'select-serial-port'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", portList: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": "[], webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", callback: (portId: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addListener:member(9)", "docComment": "/**\n * Emitted after a new serial port becomes available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Content", "text": "'serial-port-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", port: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#addWordToSpellCheckerDictionary:member(1)", "docComment": "/**\n * Writes the word to the custom dictionary. Does not work on non-persistent (in-memory) sessions.\n *\n * @param word - The word to add.\n *\n * @returns Whether the word was successfully written to the custom dictionary.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addWordToSpellCheckerDictionary(word: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "word", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addWordToSpellCheckerDictionary" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#allowNTLMCredentialsForDomains:member(1)", "docComment": "/**\n * Dynamically sets whether to always send credentials for HTTP NTLM or Negotiate authentication.\n *\n * @param domains - A comma-separated list of servers for which integrated authentication is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowNTLMCredentialsForDomains(domains: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "domains", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "allowNTLMCredentialsForDomains" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#availableSpellCheckerLanguages:member", "docComment": "/**\n * A list of all the known available spell checker languages.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly availableSpellCheckerLanguages: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "availableSpellCheckerLanguages", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#clearAuthCache:member(1)", "docComment": "/**\n * Clears the session's HTTP authentication cache.\n *\n * @returns A promise that resolves when the HTTP authentication cache has been cleared.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearAuthCache(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearAuthCache" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#clearCache:member(1)", "docComment": "/**\n * Clears the session's HTTP cache.\n *\n * @returns A promise that resolves when the cache clear operation is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearCache(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearCache" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#clearCodeCaches:member(1)", "docComment": "/**\n * Clears the session's generated JS code caches.\n *\n * @param options - Options controlling which code caches are cleared.\n *\n * @returns A promise that resolves when the code cache clear operation is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearCodeCaches(options: " }, { "kind": "Reference", "text": "ElectronClearCodeCachesOptions", "canonicalReference": "obsidian-typings!ElectronClearCodeCachesOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "clearCodeCaches" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#clearHostResolverCache:member(1)", "docComment": "/**\n * Clears the host resolver cache.\n *\n * @returns A promise that resolves when the operation is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearHostResolverCache(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearHostResolverCache" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#clearStorageData:member(1)", "docComment": "/**\n * Clears the storage data for the current session.\n *\n * @param options - Options controlling which storage data is cleared.\n *\n * @returns A promise that resolves when the storage data has been cleared.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearStorageData(options?: " }, { "kind": "Reference", "text": "ElectronClearStorageDataOptions", "canonicalReference": "obsidian-typings!ElectronClearStorageDataOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "clearStorageData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#closeAllConnections:member(1)", "docComment": "/**\n * Closes all connections, terminating any requests currently in flight.\n *\n * @returns A promise that resolves when all connections are closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeAllConnections(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "closeAllConnections" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#cookies:member", "docComment": "/**\n * A `Cookies` object for this session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly cookies: " }, { "kind": "Reference", "text": "ElectronCookies", "canonicalReference": "obsidian-typings!ElectronCookies:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "cookies", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#createInterruptedDownload:member(1)", "docComment": "/**\n * Allows resuming a cancelled or interrupted download from a previous session.\n *\n * @param options - Options describing the interrupted download to resume.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createInterruptedDownload(options: " }, { "kind": "Reference", "text": "ElectronCreateInterruptedDownloadOptions", "canonicalReference": "obsidian-typings!ElectronCreateInterruptedDownloadOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createInterruptedDownload" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#defaultSession:member", "docComment": "/**\n * The default session object of the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultSession: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultSession", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#disableNetworkEmulation:member(1)", "docComment": "/**\n * Disables any network emulation already active for the session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableNetworkEmulation(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "disableNetworkEmulation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#downloadURL:member(1)", "docComment": "/**\n * Initiates a download of the resource at `url`.\n *\n * @param url - The URL of the resource to download.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadURL(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "downloadURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#enableNetworkEmulation:member(1)", "docComment": "/**\n * Emulates network with the given configuration for the session.\n *\n * @param options - The network emulation configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableNetworkEmulation(options: " }, { "kind": "Reference", "text": "ElectronEnableNetworkEmulationOptions", "canonicalReference": "obsidian-typings!ElectronEnableNetworkEmulationOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "enableNetworkEmulation" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#flushStorageData:member(1)", "docComment": "/**\n * Writes any unwritten DOMStorage data to disk.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "flushStorageData(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "flushStorageData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#forceReloadProxyConfig:member(1)", "docComment": "/**\n * Resets all internal states of the proxy service and reapplies the latest proxy configuration.\n *\n * @returns A promise that resolves when the proxy configuration is reapplied.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forceReloadProxyConfig(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "forceReloadProxyConfig" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#fromPartition:member(1)", "docComment": "/**\n * Returns a session instance from the `partition` string, creating one with `options` if none exists.\n *\n * @param partition - The partition string.\n *\n * @param options - Options used when creating a new session.\n *\n * @returns The session for the given partition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fromPartition(partition: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronFromPartitionOptions", "canonicalReference": "obsidian-typings!ElectronFromPartitionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "partition", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "fromPartition" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#getAllExtensions:member(1)", "docComment": "/**\n * Returns a list of all loaded extensions.\n *\n * @returns The loaded extensions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAllExtensions(): " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getAllExtensions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#getBlobData:member(1)", "docComment": "/**\n * Returns the blob data associated with the given identifier.\n *\n * @param identifier - The blob UUID.\n *\n * @returns A promise that resolves with the blob data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBlobData(identifier: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"node:buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "identifier", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getBlobData" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#getCacheSize:member(1)", "docComment": "/**\n * Returns the session's current cache size, in bytes.\n *\n * @returns A promise that resolves with the cache size in bytes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCacheSize(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<number>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCacheSize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#getExtension:member(1)", "docComment": "/**\n * Returns the loaded extension with the given ID.\n *\n * @param extensionId - The extension ID.\n *\n * @returns The loaded extension.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getExtension(extensionId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extensionId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getExtension" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#getPreloads:member(1)", "docComment": "/**\n * Returns an array of paths to preload scripts that have been registered.\n *\n * @returns The registered preload script paths.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getPreloads(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getPreloads" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#getSpellCheckerLanguages:member(1)", "docComment": "/**\n * Returns an array of language codes the spellchecker is enabled for.\n *\n * @returns The enabled spell checker language codes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSpellCheckerLanguages(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSpellCheckerLanguages" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#getStoragePath:member(1)", "docComment": "/**\n * Returns the absolute file system path where data for this session is persisted on disk.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getStoragePath(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getStoragePath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#getUserAgent:member(1)", "docComment": "/**\n * Returns the user agent for this session.\n *\n * @returns The user agent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getUserAgent(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getUserAgent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#isPersistent:member(1)", "docComment": "/**\n * Returns whether or not this session is a persistent one.\n *\n * @returns Whether the session is persistent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isPersistent(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isPersistent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#isSpellCheckerEnabled:member(1)", "docComment": "/**\n * Returns whether the builtin spell checker is enabled.\n *\n * @returns Whether the spell checker is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isSpellCheckerEnabled(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "isSpellCheckerEnabled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#listWordsInSpellCheckerDictionary:member(1)", "docComment": "/**\n * Returns all words in the app's custom dictionary.\n *\n * @returns A promise that resolves with all words in the custom dictionary.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "listWordsInSpellCheckerDictionary(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "listWordsInSpellCheckerDictionary" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#loadExtension:member(1)", "docComment": "/**\n * Loads a Chrome extension from `path`.\n *\n * @param path - The path to the unpacked extension.\n *\n * @param options - Options controlling how the extension is loaded.\n *\n * @returns A promise that resolves with the loaded extension.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadExtension(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ElectronLoadExtensionOptions", "canonicalReference": "obsidian-typings!ElectronLoadExtensionOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadExtension" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#netLog:member", "docComment": "/**\n * A `NetLog` object for this session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly netLog: " }, { "kind": "Reference", "text": "ElectronNetLog", "canonicalReference": "obsidian-typings!ElectronNetLog:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "netLog", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(1)", "docComment": "/**\n * Emitted after an extension is loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'extension-loaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(10)", "docComment": "/**\n * Emitted after a serial port has been removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'serial-port-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", port: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(11)", "docComment": "/**\n * Emitted when a hunspell dictionary file starts downloading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(12)", "docComment": "/**\n * Emitted when a hunspell dictionary file download fails.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-failure'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(13)", "docComment": "/**\n * Emitted when a hunspell dictionary file has been successfully downloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-success'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(14)", "docComment": "/**\n * Emitted when a hunspell dictionary file has been successfully initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-initialized'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(15)", "docComment": "/**\n * Emitted when Electron is about to download `item` in `webContents`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'will-download'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", item: " }, { "kind": "Reference", "text": "ElectronDownloadItem", "canonicalReference": "obsidian-typings!ElectronDownloadItem:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(2)", "docComment": "/**\n * Emitted after an extension is loaded and all necessary browser state is initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'extension-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(3)", "docComment": "/**\n * Emitted after an extension is unloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'extension-unloaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(4)", "docComment": "/**\n * Emitted when a new HID device becomes available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'hid-device-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronHidDeviceAddedDetails", "canonicalReference": "obsidian-typings!ElectronHidDeviceAddedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(5)", "docComment": "/**\n * Emitted when a HID device has been removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'hid-device-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronHidDeviceRemovedDetails", "canonicalReference": "obsidian-typings!ElectronHidDeviceRemovedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(6)", "docComment": "/**\n * Emitted when a render process requests preconnection to a URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'preconnect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preconnectUrl: string, allowCredentials: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(7)", "docComment": "/**\n * Emitted when a HID device needs to be selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'select-hid-device'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronSelectHidDeviceDetails", "canonicalReference": "obsidian-typings!ElectronSelectHidDeviceDetails:interface" }, { "kind": "Content", "text": ", callback: (deviceId?: null | string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(8)", "docComment": "/**\n * Emitted when a serial port needs to be selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'select-serial-port'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", portList: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": "[], webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", callback: (portId: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#on:member(9)", "docComment": "/**\n * Emitted after a new serial port becomes available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Content", "text": "'serial-port-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", port: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(1)", "docComment": "/**\n * Emitted after an extension is loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'extension-loaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(10)", "docComment": "/**\n * Emitted after a serial port has been removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'serial-port-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", port: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(11)", "docComment": "/**\n * Emitted when a hunspell dictionary file starts downloading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(12)", "docComment": "/**\n * Emitted when a hunspell dictionary file download fails.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-failure'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(13)", "docComment": "/**\n * Emitted when a hunspell dictionary file has been successfully downloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-success'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(14)", "docComment": "/**\n * Emitted when a hunspell dictionary file has been successfully initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-initialized'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(15)", "docComment": "/**\n * Emitted when Electron is about to download `item` in `webContents`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'will-download'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", item: " }, { "kind": "Reference", "text": "ElectronDownloadItem", "canonicalReference": "obsidian-typings!ElectronDownloadItem:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(2)", "docComment": "/**\n * Emitted after an extension is loaded and all necessary browser state is initialized.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'extension-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(3)", "docComment": "/**\n * Emitted after an extension is unloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'extension-unloaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(4)", "docComment": "/**\n * Emitted when a new HID device becomes available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'hid-device-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronHidDeviceAddedDetails", "canonicalReference": "obsidian-typings!ElectronHidDeviceAddedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(5)", "docComment": "/**\n * Emitted when a HID device has been removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'hid-device-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronHidDeviceRemovedDetails", "canonicalReference": "obsidian-typings!ElectronHidDeviceRemovedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(6)", "docComment": "/**\n * Emitted when a render process requests preconnection to a URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'preconnect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preconnectUrl: string, allowCredentials: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(7)", "docComment": "/**\n * Emitted when a HID device needs to be selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'select-hid-device'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronSelectHidDeviceDetails", "canonicalReference": "obsidian-typings!ElectronSelectHidDeviceDetails:interface" }, { "kind": "Content", "text": ", callback: (deviceId?: null | string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(8)", "docComment": "/**\n * Emitted when a serial port needs to be selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'select-serial-port'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", portList: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": "[], webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", callback: (portId: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#once:member(9)", "docComment": "/**\n * Emitted after a new serial port becomes available.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Content", "text": "'serial-port-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", port: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#preconnect:member(1)", "docComment": "/**\n * Preconnects the given number of sockets to an origin.\n *\n * @param options - Options describing the origin and number of sockets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preconnect(options: " }, { "kind": "Reference", "text": "ElectronPreconnectOptions", "canonicalReference": "obsidian-typings!ElectronPreconnectOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "preconnect" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#protocol:member", "docComment": "/**\n * A `Protocol` object for this session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly protocol: " }, { "kind": "Reference", "text": "ElectronProtocol", "canonicalReference": "obsidian-typings!ElectronProtocol:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "protocol", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeExtension:member(1)", "docComment": "/**\n * Unloads an extension.\n *\n * @param extensionId - The extension ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeExtension(extensionId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extensionId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeExtension" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(1)", "docComment": "/**\n * Removes a previously registered `extension-loaded` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'extension-loaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(10)", "docComment": "/**\n * Removes a previously registered `serial-port-removed` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'serial-port-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", port: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 10, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(11)", "docComment": "/**\n * Removes a previously registered `spellcheck-dictionary-download-begin` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-begin'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 11, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(12)", "docComment": "/**\n * Removes a previously registered `spellcheck-dictionary-download-failure` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-failure'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 12, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(13)", "docComment": "/**\n * Removes a previously registered `spellcheck-dictionary-download-success` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-download-success'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 13, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(14)", "docComment": "/**\n * Removes a previously registered `spellcheck-dictionary-initialized` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'spellcheck-dictionary-initialized'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", languageCode: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 14, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(15)", "docComment": "/**\n * Removes a previously registered `will-download` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'will-download'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", item: " }, { "kind": "Reference", "text": "ElectronDownloadItem", "canonicalReference": "obsidian-typings!ElectronDownloadItem:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 15, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(2)", "docComment": "/**\n * Removes a previously registered `extension-ready` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'extension-ready'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(3)", "docComment": "/**\n * Removes a previously registered `extension-unloaded` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'extension-unloaded'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", extension: " }, { "kind": "Reference", "text": "ElectronExtension", "canonicalReference": "obsidian-typings!ElectronExtension:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(4)", "docComment": "/**\n * Removes a previously registered `hid-device-added` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'hid-device-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronHidDeviceAddedDetails", "canonicalReference": "obsidian-typings!ElectronHidDeviceAddedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(5)", "docComment": "/**\n * Removes a previously registered `hid-device-removed` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'hid-device-removed'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronHidDeviceRemovedDetails", "canonicalReference": "obsidian-typings!ElectronHidDeviceRemovedDetails:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(6)", "docComment": "/**\n * Removes a previously registered `preconnect` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'preconnect'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", preconnectUrl: string, allowCredentials: boolean) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(7)", "docComment": "/**\n * Removes a previously registered `select-hid-device` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'select-hid-device'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", details: " }, { "kind": "Reference", "text": "ElectronSelectHidDeviceDetails", "canonicalReference": "obsidian-typings!ElectronSelectHidDeviceDetails:interface" }, { "kind": "Content", "text": ", callback: (deviceId?: null | string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(8)", "docComment": "/**\n * Removes a previously registered `select-serial-port` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'select-serial-port'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", portList: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": "[], webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", callback: (portId: string) => void) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeListener:member(9)", "docComment": "/**\n * Removes a previously registered `serial-port-added` event listener.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Content", "text": "'serial-port-added'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(event: " }, { "kind": "Reference", "text": "ElectronEvent", "canonicalReference": "obsidian-typings!ElectronEvent:interface" }, { "kind": "Content", "text": ", port: " }, { "kind": "Reference", "text": "ElectronSerialPort", "canonicalReference": "obsidian-typings!ElectronSerialPort:interface" }, { "kind": "Content", "text": ", webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 }, "isOptional": false } ], "name": "removeListener" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#removeWordFromSpellCheckerDictionary:member(1)", "docComment": "/**\n * Removes the word from the custom dictionary. Does not work on non-persistent (in-memory) sessions.\n *\n * @param word - The word to remove.\n *\n * @returns Whether the word was successfully removed from the custom dictionary.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeWordFromSpellCheckerDictionary(word: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "word", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeWordFromSpellCheckerDictionary" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#resolveProxy:member(1)", "docComment": "/**\n * Resolves the proxy information for `url`.\n *\n * @param url - The URL to resolve the proxy for.\n *\n * @returns A promise that resolves with the proxy information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolveProxy(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "resolveProxy" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#serviceWorkers:member", "docComment": "/**\n * A `ServiceWorkers` object for this session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly serviceWorkers: " }, { "kind": "Reference", "text": "ElectronServiceWorkers", "canonicalReference": "obsidian-typings!ElectronServiceWorkers:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "serviceWorkers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setBluetoothPairingHandler:member(1)", "docComment": "/**\n * Sets a handler to respond to Bluetooth pairing requests.\n *\n * @param handler - The pairing handler, or `null` to remove it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBluetoothPairingHandler(handler: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronBluetoothPairingHandlerHandlerDetails", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingHandlerHandlerDetails:interface" }, { "kind": "Content", "text": ", callback: (response: " }, { "kind": "Reference", "text": "ElectronBluetoothPairingResponse", "canonicalReference": "obsidian-typings!ElectronBluetoothPairingResponse:interface" }, { "kind": "Content", "text": ") => void) => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "setBluetoothPairingHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setCertificateVerifyProc:member(1)", "docComment": "/**\n * Sets the certificate verify proc for the session.\n *\n * @param proc - The verification procedure, or `null` to revert to the default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCertificateVerifyProc(proc: " }, { "kind": "Content", "text": "((request: " }, { "kind": "Reference", "text": "ElectronRequest", "canonicalReference": "obsidian-typings!ElectronRequest:interface" }, { "kind": "Content", "text": ", callback: (verificationResult: number) => void) => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "proc", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "setCertificateVerifyProc" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setCodeCachePath:member(1)", "docComment": "/**\n * Sets the directory to store the generated JS code cache for this session.\n *\n * @param path - The directory to store the code cache in.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCodeCachePath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setCodeCachePath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setDevicePermissionHandler:member(1)", "docComment": "/**\n * Sets the handler used to respond to device permission checks for the session.\n *\n * @param handler - The handler returning whether the device is permitted, or `null` to clear it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDevicePermissionHandler(handler: " }, { "kind": "Content", "text": "((details: " }, { "kind": "Reference", "text": "ElectronDevicePermissionHandlerHandlerDetails", "canonicalReference": "obsidian-typings!ElectronDevicePermissionHandlerHandlerDetails:interface" }, { "kind": "Content", "text": ") => boolean) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "setDevicePermissionHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setDownloadPath:member(1)", "docComment": "/**\n * Sets the download saving directory.\n *\n * @param path - The directory to save downloads to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDownloadPath(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setDownloadPath" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setPermissionCheckHandler:member(1)", "docComment": "/**\n * Sets the handler used to respond to permission checks for the session.\n *\n * @param handler - The handler returning whether the permission is allowed, or `null` to clear it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPermissionCheckHandler(handler: " }, { "kind": "Content", "text": "((webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": " | null, permission: string, requestingOrigin: string, details: " }, { "kind": "Reference", "text": "ElectronPermissionCheckHandlerHandlerDetails", "canonicalReference": "obsidian-typings!ElectronPermissionCheckHandlerHandlerDetails:interface" }, { "kind": "Content", "text": ") => boolean) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "setPermissionCheckHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setPermissionRequestHandler:member(1)", "docComment": "/**\n * Sets the handler used to respond to permission requests for the session.\n *\n * @param handler - The handler invoking the callback to allow or reject the permission, or `null` to clear it.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPermissionRequestHandler(handler: " }, { "kind": "Content", "text": "((webContents: " }, { "kind": "Reference", "text": "ElectronWebContents", "canonicalReference": "obsidian-typings!ElectronWebContents:interface" }, { "kind": "Content", "text": ", permission: 'clipboard-read' | 'display-capture' | 'fullscreen' | 'geolocation' | 'media' | 'mediaKeySystem' | 'midi' | 'midiSysex' | 'notifications' | 'openExternal' | 'pointerLock' | 'unknown', callback: (permissionGranted: boolean) => void, details: " }, { "kind": "Reference", "text": "ElectronPermissionRequestHandlerHandlerDetails", "canonicalReference": "obsidian-typings!ElectronPermissionRequestHandlerHandlerDetails:interface" }, { "kind": "Content", "text": ") => void) | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false } ], "name": "setPermissionRequestHandler" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setPreloads:member(1)", "docComment": "/**\n * Adds scripts that will be executed on all web contents associated with this session just before normal preload scripts run.\n *\n * @param preloads - The paths to the preload scripts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPreloads(preloads: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "preloads", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setPreloads" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setProxy:member(1)", "docComment": "/**\n * Sets the proxy settings.\n *\n * @param config - The proxy configuration.\n *\n * @returns A promise that resolves when the proxy setting process is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setProxy(config: " }, { "kind": "Reference", "text": "ElectronConfig", "canonicalReference": "obsidian-typings!ElectronConfig:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setProxy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setSpellCheckerDictionaryDownloadURL:member(1)", "docComment": "/**\n * Overrides the URL used to download hunspell dictionaries.\n *\n * @param url - The base URL to download dictionaries from, with a trailing slash.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSpellCheckerDictionaryDownloadURL(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSpellCheckerDictionaryDownloadURL" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setSpellCheckerEnabled:member(1)", "docComment": "/**\n * Sets whether to enable the builtin spell checker.\n *\n * @param enable - Whether to enable the spell checker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSpellCheckerEnabled(enable: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "enable", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSpellCheckerEnabled" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setSpellCheckerLanguages:member(1)", "docComment": "/**\n * Sets the languages the spell checker should check.\n *\n * @param languages - An array of language codes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSpellCheckerLanguages(languages: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "languages", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSpellCheckerLanguages" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setSSLConfig:member(1)", "docComment": "/**\n * Sets the SSL configuration for the session.\n *\n * @param config - The SSL configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSSLConfig(config: " }, { "kind": "Reference", "text": "ElectronSSLConfigConfig", "canonicalReference": "obsidian-typings!ElectronSSLConfigConfig:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSSLConfig" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Session#setUserAgent:member(1)", "docComment": "/**\n * Overrides the user agent and accept languages for this session.\n *\n * @param userAgent - The user agent string.\n *\n * @param acceptLanguages - A comma-separated ordered list of language codes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUserAgent(userAgent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", acceptLanguages?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "userAgent", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "acceptLanguages", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "setUserAgent" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#spellCheckerEnabled:member", "docComment": "/**\n * Whether the builtin spell checker is enabled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "spellCheckerEnabled: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "spellCheckerEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#storagePath:member", "docComment": "/**\n * The absolute file system path where data for this session is persisted on disk, or `null` for in-memory sessions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly storagePath: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "storagePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Session#webRequest:member", "docComment": "/**\n * A `WebRequest` object for this session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly webRequest: " }, { "kind": "Reference", "text": "ElectronWebRequest", "canonicalReference": "obsidian-typings!ElectronWebRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "webRequest", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SetActiveLeafParams:interface", "docComment": "/**\n * Parameters for setting the active leaf.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SetActiveLeafParams " } ], "fileUrlPath": "src/obsidian/internals/workspace/SetActiveLeafParams.d.ts", "releaseTag": "Public", "name": "SetActiveLeafParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SetActiveLeafParams#focus:member", "docComment": "/**\n * Whether to focus the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "focus", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SetBookmarkOptions:interface", "docComment": "/**\n * Options for setting a bookmark in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SetBookmarkOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/SetBookmarkOptions.d.ts", "releaseTag": "Public", "name": "SetBookmarkOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SetBookmarkOptions#insertLeft:member", "docComment": "/**\n * Whether the bookmark should be inserted to the left of the character at the position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertLeft?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "insertLeft", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!setDefaultNamespace:var", "docComment": "/**\n * Sets the default namespace.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDefaultNamespace: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['setDefaultNamespace']" } ], "fileUrlPath": "src/i18next/internals/functions/setDefaultNamespace.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "setDefaultNamespace", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SetHighlightMatch:interface", "docComment": "/**\n * Parameters for setting a highlight match in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SetHighlightMatch " } ], "fileUrlPath": "src/obsidian/internals/SetHighlightMatch.d.ts", "releaseTag": "Public", "name": "SetHighlightMatch", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SetHighlightMatch#endLoc:member", "docComment": "/**\n * End character offset of the highlight.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "endLoc?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "endLoc", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SetHighlightMatch#focus:member", "docComment": "/**\n * Whether to focus the editor on the highlighted match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focus", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SetHighlightMatch#line:member", "docComment": "/**\n * Line number of the highlight.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "line?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "line", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SetHighlightMatch#match:member", "docComment": "/**\n * The match data associated with this highlight.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "match?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "match", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SetHighlightMatch#startLoc:member", "docComment": "/**\n * Start character offset of the highlight.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startLoc?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "startLoc", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SetSelectionOptions:interface", "docComment": "/**\n * Options for setting a selection in the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SetSelectionOptions " } ], "fileUrlPath": "src/@codemirror__view/internals/SetSelectionOptions.d.ts", "releaseTag": "Public", "name": "SetSelectionOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SetSelectionOptions#origin:member", "docComment": "/**\n * The origin identifier for the selection change (e.g., user action or programmatic).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SharedFile:interface", "docComment": "/**\n * Represents a file shared to Obsidian from another app on mobile.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SharedFile " } ], "fileUrlPath": "src/obsidian/internals/SharedFile.d.ts", "releaseTag": "Public", "name": "SharedFile", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SharedFile#name:member", "docComment": "/**\n * Name of the shared file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SharedFile#uri:member", "docComment": "/**\n * URI of the shared file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uri: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "uri", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ShareReceiver:interface", "docComment": "/**\n * Handler for receiving shared files and text from other apps on mobile.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ShareReceiver " } ], "fileUrlPath": "src/obsidian/internals/ShareReceiver.d.ts", "releaseTag": "Public", "name": "ShareReceiver", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ShareReceiver#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ShareReceiver#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getShareReceiverConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ShareReceiver#handleShareFiles:member(1)", "docComment": "/**\n * Handles shared files.\n *\n * @param files - Shared files.\n *\n * @returns A promise that resolves when the shared files are handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleShareFiles(files: " }, { "kind": "Reference", "text": "SharedFile", "canonicalReference": "obsidian-typings!SharedFile:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "files", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "handleShareFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ShareReceiver#handleShareText:member(1)", "docComment": "/**\n * Handles shared text.\n *\n * @param text - Shared text.\n *\n * @returns A promise that resolves when the shared text is handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleShareText(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleShareText" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ShareReceiver#importFiles:member(1)", "docComment": "/**\n * Imports shared files.\n *\n * @param files - Shared files.\n *\n * @returns A promise that resolves when the files are imported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "importFiles(files: " }, { "kind": "Reference", "text": "SharedFile", "canonicalReference": "obsidian-typings!SharedFile:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "files", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "importFiles" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ShareReceiver#setupNative:member(1)", "docComment": "/**\n * Configures mobile native events to handle file and text sharing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setupNative(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "setupNative" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ShareReceiver#setupWorkspace:member(1)", "docComment": "/**\n * Configures the workspace to handle file and text sharing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setupWorkspace(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "setupWorkspace" } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!shell:var", "docComment": "/**\n * Electron shell instance for managing files and URLs.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shell: " }, { "kind": "Reference", "text": "ElectronShell", "canonicalReference": "obsidian-typings!ElectronShell:interface" } ], "fileUrlPath": "src/electron/internals/vars/shell.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "shell", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "obsidian-typings!signal:function(1)", "docComment": "/**\n * Fires a signal (event) on the given target.\n *\n * @param target - The target object.\n *\n * @param name - The signal name.\n *\n * @param args - Additional arguments to pass to handlers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function signal(target: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ...args: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/codemirror/internals/functions/signal.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "signal" }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SlashCommandPlugin:interface", "docComment": "/**\n * Internal plugin registration for the slash command suggestions feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SlashCommandPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SlashCommandPluginInstance", "canonicalReference": "obsidian-typings!SlashCommandPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/slash-command/SlashCommandPlugin.d.ts", "releaseTag": "Public", "name": "SlashCommandPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SlashCommandPluginInstance:interface", "docComment": "/**\n * Plugin instance for slash commands, providing inline command suggestions when typing \"/\".\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SlashCommandPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SlashCommandPlugin", "canonicalReference": "obsidian-typings!SlashCommandPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/slash-command/SlashCommandPluginInstance.d.ts", "releaseTag": "Public", "name": "SlashCommandPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SlashCommandPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SliceFunction:interface", "docComment": "/**\n * Function `Slice`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SliceFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/SliceFunction.d.ts", "releaseTag": "Public", "name": "SliceFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SlidesPlugin:interface", "docComment": "/**\n * Internal plugin registration for the slides (presentation mode) feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SlidesPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SlidesPluginInstance", "canonicalReference": "obsidian-typings!SlidesPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/slides/SlidesPlugin.d.ts", "releaseTag": "Public", "name": "SlidesPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SlidesPluginInstance:interface", "docComment": "/**\n * Plugin instance for slides, providing presentation mode for Markdown files.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SlidesPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SlidesPlugin", "canonicalReference": "obsidian-typings!SlidesPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/slides/SlidesPluginInstance.d.ts", "releaseTag": "Public", "name": "SlidesPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SlidesPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!Sprite:class", "docComment": "/**\n * Sprite display object.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Sprite extends " }, { "kind": "Reference", "text": "Container", "canonicalReference": "obsidian-typings!Container:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/pixi.js/internals/Sprite.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Sprite", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!Sprite:constructor(1)", "docComment": "/**\n * Creates a new sprite.\n *\n * @param texture - The texture to use.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(texture?: " }, { "kind": "Reference", "text": "Texture", "canonicalReference": "obsidian-typings!Texture:class" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "texture", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!Sprite#anchor:member", "docComment": "/**\n * Anchor point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get anchor(): " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";\n\nset anchor(value: " }, { "kind": "Reference", "text": "IPointData", "canonicalReference": "obsidian-typings!IPointData:interface" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "anchor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!Sprite#destroy:member(1)", "docComment": "/**\n * Destroys this sprite.\n *\n * @param options - Destroy options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "destroy(options?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "IDestroyOptions", "canonicalReference": "obsidian-typings!IDestroyOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "destroy" }, { "kind": "Method", "canonicalReference": "obsidian-typings!Sprite.from:member(1)", "docComment": "/**\n * Creates a sprite from the given source.\n *\n * @param source - The sprite source.\n *\n * @returns The created sprite.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static from(source: " }, { "kind": "Reference", "text": "SpriteSource", "canonicalReference": "obsidian-typings!SpriteSource:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Sprite", "canonicalReference": "obsidian-typings!Sprite:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "from" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Sprite#height:member", "docComment": "/**\n * Height of the sprite.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get height(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";\n\nset height(value: number);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Sprite#texture:member", "docComment": "/**\n * Texture of the sprite.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get texture(): " }, { "kind": "Reference", "text": "Texture", "canonicalReference": "obsidian-typings!Texture:class" }, { "kind": "Content", "text": ";\n\nset texture(value: " }, { "kind": "Reference", "text": "Texture", "canonicalReference": "obsidian-typings!Texture:class" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "texture", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Sprite#tint:member", "docComment": "/**\n * Tint color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get tint(): " }, { "kind": "Reference", "text": "ColorSource", "canonicalReference": "obsidian-typings!ColorSource:type" }, { "kind": "Content", "text": ";\n\nset tint(value: " }, { "kind": "Reference", "text": "ColorSource", "canonicalReference": "obsidian-typings!ColorSource:type" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Sprite#width:member", "docComment": "/**\n * Width of the sprite.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get width(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";\n\nset width(value: number);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!SpriteSource:type", "docComment": "/**\n * Source for creating a sprite.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type SpriteSource = " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Texture", "canonicalReference": "obsidian-typings!Texture:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/SpriteSource.d.ts", "releaseTag": "Public", "name": "SpriteSource", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SQLError:interface", "docComment": "/**\n * Represents an error returned from a WebSQL database operation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SQLError " } ], "fileUrlPath": "src/web-sql/internals/SQLError.d.ts", "releaseTag": "Public", "name": "SQLError", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SQLError#code:member", "docComment": "/**\n * Numeric error code identifying the type of error.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "code: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "code", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SQLError#message:member", "docComment": "/**\n * Human-readable error message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SQLResultSet:interface", "docComment": "/**\n * Result set returned from a WebSQL query execution.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SQLResultSet " } ], "fileUrlPath": "src/web-sql/internals/SQLResultSet.d.ts", "releaseTag": "Public", "name": "SQLResultSet", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SQLResultSet#insertId:member", "docComment": "/**\n * Row ID of the last inserted row, if applicable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertId: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "insertId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SQLResultSet#rows:member", "docComment": "/**\n * List of rows returned by the query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rows: " }, { "kind": "Reference", "text": "SQLResultSetRowList", "canonicalReference": "obsidian-typings!SQLResultSetRowList:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rows", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SQLResultSet#rowsAffected:member", "docComment": "/**\n * Number of rows affected by the query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rowsAffected: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rowsAffected", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SQLResultSetRowList:interface", "docComment": "/**\n * List of rows returned from a WebSQL query result.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SQLResultSetRowList " } ], "fileUrlPath": "src/web-sql/internals/SQLResultSetRowList.d.ts", "releaseTag": "Public", "name": "SQLResultSetRowList", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SQLResultSetRowList#item:member(1)", "docComment": "/**\n * Get a row by its index in the result set.\n *\n * @param index - The index of the row to retrieve.\n *\n * @returns The row at the specified index.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "item(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "item" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SQLResultSetRowList#length:member", "docComment": "/**\n * Number of rows in the result set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "length: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "length", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SQLTransaction:interface", "docComment": "/**\n * Represents a SQL transaction for executing queries against a WebSQL database.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SQLTransaction " } ], "fileUrlPath": "src/web-sql/internals/SQLTransaction.d.ts", "releaseTag": "Public", "name": "SQLTransaction", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SQLTransaction#executeSql:member(1)", "docComment": "/**\n * Execute a SQL statement within this transaction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executeSql(\n sqlStatement: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ",\n arguments?: " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ",\n callback?: " }, { "kind": "Content", "text": "(transaction: " }, { "kind": "Reference", "text": "SQLTransaction", "canonicalReference": "obsidian-typings!SQLTransaction:interface" }, { "kind": "Content", "text": ", resultSet: " }, { "kind": "Reference", "text": "SQLResultSet", "canonicalReference": "obsidian-typings!SQLResultSet:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ",\n errorCallback?: " }, { "kind": "Content", "text": "(transaction: " }, { "kind": "Reference", "text": "SQLTransaction", "canonicalReference": "obsidian-typings!SQLTransaction:interface" }, { "kind": "Content", "text": ", error: " }, { "kind": "Reference", "text": "SQLError", "canonicalReference": "obsidian-typings!SQLError:interface" }, { "kind": "Content", "text": ") => boolean" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "sqlStatement", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "arguments", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 10 }, "isOptional": true }, { "parameterName": "errorCallback", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 16 }, "isOptional": true } ], "name": "executeSql" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StateEffectDefineSpec:interface", "docComment": "/**\n * Configuration for defining a state effect type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StateEffectDefineSpec<Value> " } ], "fileUrlPath": "src/@codemirror__state/internals/StateEffectDefineSpec.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Value", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "StateEffectDefineSpec", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!StateEffectDefineSpec#map:member(1)", "docComment": "/**\n * A function to map the effect value through position changes.\n *\n * @param value - The effect value.\n *\n * @param mapping - The change description.\n *\n * @returns The mapped value, or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "map?(value: " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": ", mapping: " }, { "kind": "Reference", "text": "ChangeDesc", "canonicalReference": "obsidian-typings!~ChangeDesc" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "undefined | Value" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "mapping", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "map" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StateFieldSpec:interface", "docComment": "/**\n * Configuration for defining a state field.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StateFieldSpec<Value> " } ], "fileUrlPath": "src/@codemirror__state/internals/StateFieldSpec.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Value", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "StateFieldSpec", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!StateFieldSpec#compare:member(1)", "docComment": "/**\n * Compare two values of this field.\n *\n * @param a - The first value.\n *\n * @param b - The second value.\n *\n * @returns Whether the values are equal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "compare?(a: " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": ", b: " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "a", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "compare" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!StateFieldSpec#create:member(1)", "docComment": "/**\n * Create the initial value for this field.\n *\n * @param state - The editor state.\n *\n * @returns The initial value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "create(state: " }, { "kind": "Reference", "text": "EditorState", "canonicalReference": "obsidian-typings!~EditorState" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "create" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!StateFieldSpec#provide:member(1)", "docComment": "/**\n * Provide extensions based on this field.\n *\n * @param field - The state field.\n *\n * @returns The extension.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "provide?(field: " }, { "kind": "Reference", "text": "StateField", "canonicalReference": "obsidian-typings!~StateField" }, { "kind": "Content", "text": "<Value>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Extension", "canonicalReference": "@codemirror/state!Extension:type" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "field", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "provide" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!StateFieldSpec#update:member(1)", "docComment": "/**\n * Compute a new value from the field's previous value and a transaction.\n *\n * @param value - The previous value.\n *\n * @param transaction - The transaction.\n *\n * @returns The updated value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(value: " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": ", transaction: " }, { "kind": "Reference", "text": "Transaction", "canonicalReference": "obsidian-typings!~Transaction" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "transaction", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "update" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StateHistory:interface", "docComment": "/**\n * Captured state of a workspace leaf for history navigation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StateHistory " } ], "fileUrlPath": "src/obsidian/internals/StateHistory.d.ts", "releaseTag": "Public", "name": "StateHistory", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistory#eState:member", "docComment": "/**\n * Ephemeral cursor state within {@link obsidian#Editor} of leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eState: " }, { "kind": "Reference", "text": "StateHistoryEphemeralState", "canonicalReference": "obsidian-typings!StateHistoryEphemeralState:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "eState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistory#icon:member", "docComment": "/**\n * Icon of the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistory#leafHistory:member", "docComment": "/**\n * History of previous and future states of leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "leafHistory?: " }, { "kind": "Reference", "text": "StateHistoryLeafHistory", "canonicalReference": "obsidian-typings!StateHistoryLeafHistory:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "leafHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistory#parentId:member", "docComment": "/**\n * Id of parent to which the leaf belonged.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parentId?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "parentId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistory#rootId:member", "docComment": "/**\n * Id of root to which the leaf belonged.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rootId?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rootId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistory#state:member", "docComment": "/**\n * Last state of the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Reference", "text": "ViewState", "canonicalReference": "obsidian!ViewState:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistory#title:member", "docComment": "/**\n * Title of the leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StateHistoryEphemeralState:interface", "docComment": "/**\n * Ephemeral editor state stored in the state history (cursor and scroll position).\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StateHistoryEphemeralState " } ], "fileUrlPath": "src/obsidian/internals/StateHistoryEphemeralState.d.ts", "releaseTag": "Public", "name": "StateHistoryEphemeralState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistoryEphemeralState#cursor:member", "docComment": "/**\n * Cursor selection range in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursor: " }, { "kind": "Reference", "text": "EditorRange", "canonicalReference": "obsidian!EditorRange:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "cursor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistoryEphemeralState#scroll:member", "docComment": "/**\n * Scroll position in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scroll: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StateHistoryLeafHistory:interface", "docComment": "/**\n * Back and forward history stacks for a workspace leaf.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StateHistoryLeafHistory " } ], "fileUrlPath": "src/obsidian/internals/StateHistoryLeafHistory.d.ts", "releaseTag": "Public", "name": "StateHistoryLeafHistory", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistoryLeafHistory#backHistory:member", "docComment": "/**\n * Stack of previous leaf states for back navigation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backHistory: " }, { "kind": "Reference", "text": "StateHistory", "canonicalReference": "obsidian-typings!StateHistory:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StateHistoryLeafHistory#forwardHistory:member", "docComment": "/**\n * Stack of forward leaf states for forward navigation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forwardHistory: " }, { "kind": "Reference", "text": "StateHistory", "canonicalReference": "obsidian-typings!StateHistory:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "forwardHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StatusBar:interface", "docComment": "/**\n * The status bar displayed at the bottom of the application window.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StatusBar " } ], "fileUrlPath": "src/obsidian/internals/StatusBar.d.ts", "releaseTag": "Public", "name": "StatusBar", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StatusBar#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!StatusBar#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getStatusBarConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param app - The app.\n *\n * @param containerEl - The containerEl.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ", containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "containerEl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StatusBar#containerEl:member", "docComment": "/**\n * Container element for the status bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!StatusBar#registerStatusBarItem:member(1)", "docComment": "/**\n * Register a new status bar item element.\n *\n * @returns The newly created status bar item element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerStatusBarItem(): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "registerStatusBarItem" } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!StyleModule:class", "docComment": "/**\n * A CSS module that can be mounted into a document or shadow root.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class StyleModule " } ], "fileUrlPath": "src/style-mod/internals/StyleModule.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "StyleModule", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!StyleModule:constructor(1)", "docComment": "/**\n * Create new instance of {@link StyleModule}.\n *\n * @param spec - Specification.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(spec: " }, { "kind": "Reference", "text": "StyleModuleSpec", "canonicalReference": "obsidian-typings!StyleModuleSpec:interface" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "StyleModuleOptions", "canonicalReference": "obsidian-typings!StyleModuleOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "spec", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!StyleModule#getRules:member(1)", "docComment": "/**\n * Get the generated CSS rules as a string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRules(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getRules" }, { "kind": "Method", "canonicalReference": "obsidian-typings!StyleModule.mount:member(1)", "docComment": "/**\n * Mount style module(s) into a document or shadow root.\n *\n * @param root - The document or shadow root to mount into.\n *\n * @param module - The style module(s) to mount.\n *\n * @param options - Optional mount options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static mount(\n root: " }, { "kind": "Reference", "text": "Document", "canonicalReference": "!Document:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DocumentOrShadowRoot", "canonicalReference": "!DocumentOrShadowRoot:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ShadowRoot", "canonicalReference": "!ShadowRoot:interface" }, { "kind": "Content", "text": ",\n module: " }, { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "StyleModule", "canonicalReference": "obsidian-typings!StyleModule:class" }, { "kind": "Content", "text": "[] | " }, { "kind": "Reference", "text": "StyleModule", "canonicalReference": "obsidian-typings!StyleModule:class" }, { "kind": "Content", "text": ",\n options?: " }, { "kind": "Reference", "text": "StyleModuleMountOptions", "canonicalReference": "obsidian-typings!StyleModuleMountOptions:interface" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 15 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "root", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false }, { "parameterName": "module", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "mount" }, { "kind": "Method", "canonicalReference": "obsidian-typings!StyleModule.newName:member(1)", "docComment": "/**\n * Generate a new unique CSS class name.\n *\n * @returns A unique class name string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static newName(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "newName" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StyleModuleMountOptions:interface", "docComment": "/**\n * Options for mounting a style module.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StyleModuleMountOptions " } ], "fileUrlPath": "src/style-mod/internals/StyleModuleMountOptions.d.ts", "releaseTag": "Public", "name": "StyleModuleMountOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!StyleModuleMountOptions#nonce:member", "docComment": "/**\n * A Content Security Policy nonce for the generated style elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nonce?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nonce", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StyleModuleOptions:interface", "docComment": "/**\n * Options for creating a style module.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StyleModuleOptions " } ], "fileUrlPath": "src/style-mod/internals/StyleModuleOptions.d.ts", "releaseTag": "Public", "name": "StyleModuleOptions", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!StyleModuleOptions#finish:member(1)", "docComment": "/**\n * A function to post-process generated selectors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "finish?(sel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "sel", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "finish" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!StyleModuleSpec:interface", "docComment": "/**\n * A mapping of CSS selectors to style specifications.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StyleModuleSpec " } ], "fileUrlPath": "src/style-mod/internals/StyleModuleSpec.d.ts", "releaseTag": "Public", "name": "StyleModuleSpec", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "obsidian-typings!StyleModuleSpec:index(1)", "docComment": "/**\n * A CSS selector mapped to its style specification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[selector: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "StyleSpec", "canonicalReference": "obsidian-typings!StyleSpec:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "selector", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!StyleSpec:type", "docComment": "/**\n * A CSS style specification object where keys are CSS properties or nested selectors.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleSpec = " }, { "kind": "Content", "text": "{\n [propOrSelector: string]: null | number | string | " }, { "kind": "Reference", "text": "StyleSpec", "canonicalReference": "obsidian-typings!StyleSpec:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/style-mod/internals/StyleSpec.d.ts", "releaseTag": "Public", "name": "StyleSpec", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Submenu:interface", "docComment": "/**\n * Represents a submenu entry in a context menu.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Submenu " } ], "fileUrlPath": "src/obsidian/internals/Submenu.d.ts", "releaseTag": "Public", "name": "Submenu", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Submenu#icon:member", "docComment": "/**\n * Icon identifier for the submenu item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Submenu#title:member", "docComment": "/**\n * Display title for the submenu item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SuggestionContainer:interface", "docComment": "/**\n * Container for displaying and navigating editor suggestion items.\n *\n * @typeParam T - The type of the suggestion items.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SuggestionContainer<T> " } ], "fileUrlPath": "src/obsidian/internals/SuggestionContainer.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "SuggestionContainer", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#addMessage:member(1)", "docComment": "/**\n * Add an empty message with provided text.\n *\n * @param text - Message text to display.\n *\n * @returns The created message element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addMessage(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addMessage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#addSuggestion:member(1)", "docComment": "/**\n * Add suggestion to container.\n *\n * @param suggestion - Suggestion to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSuggestion(suggestion: " }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "suggestion", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addSuggestion" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestionContainer#chooser:member", "docComment": "/**\n * Which suggestions should be picked from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "chooser: " }, { "kind": "Reference", "text": "EditorSuggest", "canonicalReference": "obsidian!EditorSuggest:class" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "chooser", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestionContainer#containerEl:member", "docComment": "/**\n * Pop-up element that displays the suggestions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#forceSetSelectedItem:member(1)", "docComment": "/**\n * Set selected item to one specified by index, if keyboard navigation, force scroll into view.\n *\n * @param index - Index of the item to select.\n *\n * @param event - The triggering event.\n *\n * @remark\n *\n * Prefer setSelectedItem, which clamps the index to within suggestions array.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forceSetSelectedItem(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", event: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "forceSetSelectedItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#getSelectedElement:member(1)", "docComment": "/**\n * Get the DOM element of the currently selected suggestion.\n *\n * @returns The selected element, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSelectedElement(): " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSelectedElement" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#getSelectedValue:member(1)", "docComment": "/**\n * Get the data value of the currently selected suggestion.\n *\n * @returns The selected suggestion data, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSelectedValue(): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getSelectedValue" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#moveDown:member(1)", "docComment": "/**\n * Move selected item to next suggestion.\n *\n * @param event - The keyboard event.\n *\n * @returns Whether the move was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveDown(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "moveDown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#moveUp:member(1)", "docComment": "/**\n * Move selected item to previous suggestion.\n *\n * @param event - The keyboard event.\n *\n * @returns Whether the move was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveUp(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "moveUp" }, { "kind": "Property", "canonicalReference": "obsidian-typings!SuggestionContainer#numVisibleItems:member", "docComment": "/**\n * Amount of suggestions that can be displayed at once within containerEl.\n *\n * @returns The number of visible items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get numVisibleItems(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "numVisibleItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#onSuggestionClick:member(1)", "docComment": "/**\n * Process click on suggestion item.\n *\n * @param event - The mouse event.\n *\n * @param element - The clicked suggestion element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSuggestionClick(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", element: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onSuggestionClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#onSuggestionMouseover:member(1)", "docComment": "/**\n * Process hover on suggestion item.\n *\n * @param event - The mouse event.\n *\n * @param element - The hovered suggestion element.\n *\n * @returns The result of handling the mouseover.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSuggestionMouseover(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", element: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onSuggestionMouseover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#pageDown:member(1)", "docComment": "/**\n * Move selected item to the one in the next 'page' (next visible block).\n *\n * @param event - The keyboard event.\n *\n * @returns Whether the page-down was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageDown(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "pageDown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#pageUp:member(1)", "docComment": "/**\n * Move selected item to the one in the previous 'page' (previous visible block).\n *\n * @param event - The keyboard event.\n *\n * @returns Whether the page-up was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageUp(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "pageUp" }, { "kind": "Property", "canonicalReference": "obsidian-typings!SuggestionContainer#rowHeight:member", "docComment": "/**\n * Height in pixels of the selected item.\n *\n * @returns The row height in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get rowHeight(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "rowHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestionContainer#selectedItem:member", "docComment": "/**\n * The currently focused item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedItem: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectedItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#setSelectedItem:member(1)", "docComment": "/**\n * Set selected item to one specified by index, invokes forceSetSelectedItem.\n *\n * @param index - Index of the item to select.\n *\n * @param event - The triggering event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSelectedItem(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", event: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "setSelectedItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#setSuggestions:member(1)", "docComment": "/**\n * Empties original container and adds multiple suggestions.\n *\n * @param suggestions - Suggestions to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSuggestions(suggestions: " }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "suggestions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "setSuggestions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestionContainer#suggestions:member", "docComment": "/**\n * List of all possible suggestions as elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suggestions: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestionContainer#useSelectedItem:member(1)", "docComment": "/**\n * Use currently selected suggestion as the accepted one.\n *\n * @param event - The triggering event.\n *\n * @returns Whether a suggestion was accepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useSelectedItem(event: " }, { "kind": "Reference", "text": "Event", "canonicalReference": "!Event:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "useSelectedItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestionContainer#values:member", "docComment": "/**\n * List of all possible suggestions as data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "values: " }, { "kind": "Reference", "text": "SearchResult", "canonicalReference": "obsidian!SearchResult:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "values", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SuggestModalChooser:interface", "docComment": "/**\n * Chooser component for a suggest modal, managing suggestion selection and navigation.\n *\n * @typeParam T - The type of the suggestion items.\n *\n * @typeParam TModal - The type of the modal.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SuggestModalChooser<T, TModal> " } ], "fileUrlPath": "src/obsidian/internals/SuggestModalChooser.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TModal", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "SuggestModalChooser", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#addMessage:member(1)", "docComment": "/**\n * Display a message in the suggestion list.\n *\n * @param text - Message text or document fragment to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addMessage(text: " }, { "kind": "Reference", "text": "DocumentFragment", "canonicalReference": "!DocumentFragment:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "name": "addMessage" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#addSuggestion:member(1)", "docComment": "/**\n * Add a suggestion value to the list.\n *\n * @param value - Suggestion value to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addSuggestion(value: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addSuggestion" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#chooser:member", "docComment": "/**\n * Reference to the owning modal.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "chooser: " }, { "kind": "Content", "text": "TModal" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "chooser", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#containerEl:member", "docComment": "/**\n * Container element for the suggestion list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#forceSetSelectedItem:member(1)", "docComment": "/**\n * Set the selected item by index, forcing scroll into view.\n *\n * @param index - Index of the item to select.\n *\n * @param evt - The triggering event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forceSetSelectedItem(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", evt: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "forceSetSelectedItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#moveDown:member(1)", "docComment": "/**\n * Move selection to the next suggestion.\n *\n * @param evt - The keyboard event.\n *\n * @returns False if already at the end, void otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveDown(evt: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "false | void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "moveDown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#moveUp:member(1)", "docComment": "/**\n * Move selection to the previous suggestion.\n *\n * @param evt - The keyboard event.\n *\n * @returns False if already at the start, void otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "moveUp(evt: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "false | void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "moveUp" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#numVisibleItems:member", "docComment": "/**\n * Number of suggestions visible at once.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "numVisibleItems: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numVisibleItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#onSuggestionClick:member(1)", "docComment": "/**\n * Handle click on a suggestion element.\n *\n * @param evt - The mouse event.\n *\n * @param suggestion - The clicked suggestion element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSuggestionClick(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", suggestion: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "suggestion", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onSuggestionClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#onSuggestionMouseover:member(1)", "docComment": "/**\n * Handle mouseover on a suggestion element.\n *\n * @param evt - The mouse event.\n *\n * @param suggestion - The hovered suggestion element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSuggestionMouseover(evt: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", suggestion: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "suggestion", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onSuggestionMouseover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#pageDown:member(1)", "docComment": "/**\n * Move selection down by one page of visible items.\n *\n * @param evt - The keyboard event.\n *\n * @returns False if already at the end, void otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageDown(evt: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "false | void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "pageDown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#pageUp:member(1)", "docComment": "/**\n * Move selection up by one page of visible items.\n *\n * @param evt - The keyboard event.\n *\n * @returns False if already at the start, void otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageUp(evt: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "false | void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "pageUp" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#rowHeight:member", "docComment": "/**\n * Height of each suggestion row in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rowHeight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rowHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#selectedItem:member", "docComment": "/**\n * Index of the currently selected suggestion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedItem: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectedItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#setSelectedItem:member(1)", "docComment": "/**\n * Set the selected item by index.\n *\n * @param index - Index of the item to select.\n *\n * @param evt - The triggering event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSelectedItem(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", evt: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "setSelectedItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#setSuggestions:member(1)", "docComment": "/**\n * Replace all suggestions with new values.\n *\n * @param values - Suggestion values to display, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setSuggestions(values: " }, { "kind": "Content", "text": "null | T[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setSuggestions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#suggestions:member", "docComment": "/**\n * DOM elements for each suggestion row.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suggestions: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#useSelectedItem:member(1)", "docComment": "/**\n * Accept the currently selected suggestion.\n *\n * @param evt - The triggering event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useSelectedItem(evt: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "evt", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "useSelectedItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SuggestModalChooser#values:member", "docComment": "/**\n * Current suggestion values, or `null` if none.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "values: " }, { "kind": "Content", "text": "null | T[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "values", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SwitcherPlugin:interface", "docComment": "/**\n * Internal plugin registration for the quick switcher feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SwitcherPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SwitcherPluginInstance", "canonicalReference": "obsidian-typings!SwitcherPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/switcher/SwitcherPlugin.d.ts", "releaseTag": "Public", "name": "SwitcherPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SwitcherPluginInstance:interface", "docComment": "/**\n * Plugin instance for the quick switcher, providing fuzzy file search and navigation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SwitcherPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SwitcherPlugin", "canonicalReference": "obsidian-typings!SwitcherPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/switcher/SwitcherPluginInstance.d.ts", "releaseTag": "Public", "name": "SwitcherPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SwitcherPluginInstance#activeModal:member", "docComment": "/**\n * The currently open quick-switcher modal, or `null` if none is open.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "activeModal: " }, { "kind": "Reference", "text": "Modal", "canonicalReference": "obsidian!Modal:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "activeModal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SwitcherPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SwitcherPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SwitcherPluginInstance#onExternalSettingsChange:member(1)", "docComment": "/**\n * Handles a settings change made externally (e.g. by Sync).\n *\n * @returns A promise that resolves when the change has been handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalSettingsChange(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onExternalSettingsChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SwitcherPluginInstance#onOpen:member(1)", "docComment": "/**\n * Opens the quick switcher.\n *\n * @returns A promise that resolves when the switcher is open.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onOpen(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onOpen" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SwitcherPluginInstance#options:member", "docComment": "/**\n * The plugin's options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SwitcherPluginInstance#plugin:member", "docComment": "/**\n * Reference to the switcher plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "SwitcherPlugin", "canonicalReference": "obsidian-typings!SwitcherPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SwitcherPluginInstance#QuickSwitcherModal:member", "docComment": "/**\n * The quick-switcher modal constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "QuickSwitcherModal: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "QuickSwitcherModal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SyncPlugin:interface", "docComment": "/**\n * Internal plugin registration for the Obsidian Sync cloud sync feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SyncPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SyncPluginInstance", "canonicalReference": "obsidian-typings!SyncPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/sync/SyncPlugin.d.ts", "releaseTag": "Public", "name": "SyncPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SyncPluginInstance:interface", "docComment": "/**\n * Plugin instance for Obsidian Sync, managing cloud synchronization of vault data.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SyncPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SyncPlugin", "canonicalReference": "obsidian-typings!SyncPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/sync/SyncPluginInstance.d.ts", "releaseTag": "Public", "name": "SyncPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyncPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyncPluginInstance#plugin:member", "docComment": "/**\n * Reference to the sync plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "SyncPlugin", "canonicalReference": "obsidian-typings!SyncPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SyncView:interface", "docComment": "/**\n * {@link obsidian#View} that displays the Obsidian Sync status and settings.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SyncView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/sync/SyncView.d.ts", "releaseTag": "Public", "name": "SyncView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SyncView#constructor3__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param leaf - The workspace leaf.\n *\n * @param syncPluginInstance - The sync plugin instance.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor3__?(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", syncPluginInstance: " }, { "kind": "Reference", "text": "SyncPluginInstance", "canonicalReference": "obsidian-typings!SyncPluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "syncPluginInstance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor3__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SyncView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The sync view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Sync", "canonicalReference": "obsidian-typings!~__type#Sync:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SyntaxNode:interface", "docComment": "/**\n * Represents a node in the syntax tree.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SyntaxNode " } ], "fileUrlPath": "src/@lezer__common/internals/SyntaxNode.d.ts", "releaseTag": "Public", "name": "SyntaxNode", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SyntaxNode#cursor:member(1)", "docComment": "/**\n * Create a tree cursor starting at this node.\n *\n * @param mode - The iteration mode.\n *\n * @returns A tree cursor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursor(mode?: " }, { "kind": "Reference", "text": "IterMode", "canonicalReference": "obsidian-typings!IterMode:enum" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "LezerTreeCursor", "canonicalReference": "obsidian-typings!LezerTreeCursor:class" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "cursor" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#firstChild:member", "docComment": "/**\n * The first child node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "firstChild: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "firstChild", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#from:member", "docComment": "/**\n * The start position of this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#lastChild:member", "docComment": "/**\n * The last child node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastChild: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastChild", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#name:member", "docComment": "/**\n * The name of the node type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#nextSibling:member", "docComment": "/**\n * The next sibling node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nextSibling: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nextSibling", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#parent:member", "docComment": "/**\n * The parent node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parent: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#prevSibling:member", "docComment": "/**\n * The previous sibling node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prevSibling: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "prevSibling", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!SyntaxNode#resolve:member(1)", "docComment": "/**\n * Resolve the node at the given position.\n *\n * @param pos - The position to resolve.\n *\n * @param side - Which side of the position to prefer.\n *\n * @returns The resolved syntax node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resolve(pos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", side?: " }, { "kind": "Content", "text": "-1 | 0 | 1" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pos", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "side", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "resolve" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#to:member", "docComment": "/**\n * The end position of this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#tree:member", "docComment": "/**\n * The tree that this node belongs to, if it is a top node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tree: " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tree", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNode#type:member", "docComment": "/**\n * The type of this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!SyntaxNodeRef:interface", "docComment": "/**\n * A reference to a syntax node, providing its position and type information.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SyntaxNodeRef " } ], "fileUrlPath": "src/@lezer__common/internals/SyntaxNodeRef.d.ts", "releaseTag": "Public", "name": "SyntaxNodeRef", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNodeRef#from:member", "docComment": "/**\n * The start position of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly from: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNodeRef#name:member", "docComment": "/**\n * The name of the node type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNodeRef#node:member", "docComment": "/**\n * The actual syntax node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly node: " }, { "kind": "Reference", "text": "SyntaxNode", "canonicalReference": "obsidian-typings!SyntaxNode:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "node", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNodeRef#to:member", "docComment": "/**\n * The end position of the node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly to: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNodeRef#tree:member", "docComment": "/**\n * The tree that this node belongs to, if it is a top node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly tree: " }, { "kind": "Reference", "text": "LezerTree", "canonicalReference": "obsidian-typings!LezerTree:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "tree", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!SyntaxNodeRef#type:member", "docComment": "/**\n * The type of this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly type: " }, { "kind": "Reference", "text": "NodeType", "canonicalReference": "obsidian-typings!NodeType:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!t:var", "docComment": "/**\n * Translates a key to a localized string.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "t: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['t']" } ], "fileUrlPath": "src/i18next/internals/functions/t.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "t", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TableCell:interface", "docComment": "/**\n * Represents a single cell in a markdown table.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TableCell " } ], "fileUrlPath": "src/obsidian/internals/TableCell.d.ts", "releaseTag": "Public", "name": "TableCell", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#col:member", "docComment": "/**\n * Column index of the cell.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "col: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "col", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#contentEl:member", "docComment": "/**\n * Element containing the cell's content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#dirty:member", "docComment": "/**\n * Whether the cell has been modified since the last save.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dirty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dirty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#el:member", "docComment": "/**\n * DOM element for the cell.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "el", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#end:member", "docComment": "/**\n * End offset of the cell content in the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "end: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "end", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#padEnd:member", "docComment": "/**\n * Trailing padding characters in the cell.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "padEnd: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "padEnd", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#padStart:member", "docComment": "/**\n * Leading padding characters in the cell.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "padStart: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "padStart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#row:member", "docComment": "/**\n * Row index of the cell.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "row: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "row", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#start:member", "docComment": "/**\n * Start offset of the cell content in the document.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "start: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "start", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#table:member", "docComment": "/**\n * Table cell editor that manages this cell.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "table: " }, { "kind": "Reference", "text": "TableCellEditor", "canonicalReference": "obsidian-typings!TableCellEditor:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "table", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TableCell#text:member", "docComment": "/**\n * Text content of the cell.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TableCellEditor:interface", "docComment": "/**\n * {@link obsidian#Editor} for a single table cell, combining markdown editing with cell properties.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TableCellEditor extends " }, { "kind": "Reference", "text": "MarkdownBaseView", "canonicalReference": "obsidian-typings!MarkdownBaseView:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TableCell", "canonicalReference": "obsidian-typings!TableCell:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/TableCellEditor.d.ts", "releaseTag": "Public", "name": "TableCellEditor", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TableEditor:interface", "docComment": "/**\n * {@link obsidian#Editor} for managing markdown tables.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TableEditor " } ], "fileUrlPath": "src/obsidian/internals/TableEditor.d.ts", "releaseTag": "Public", "name": "TableEditor", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TableView:interface", "docComment": "/**\n * Table view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TableView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/TableView.d.ts", "releaseTag": "Public", "name": "TableView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TableView#getViewType:member(1)", "docComment": "/**\n * Get view type.\n *\n * @returns The table view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Table", "canonicalReference": "obsidian-typings!~__type#Table:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TaggedWithFunction:interface", "docComment": "/**\n * Function `TaggedWith`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TaggedWithFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetDisplayName", "canonicalReference": "obsidian-typings!HasGetDisplayName:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasGetRHSWidgetType", "canonicalReference": "obsidian-typings!HasGetRHSWidgetType:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/TaggedWithFunction.d.ts", "releaseTag": "Public", "name": "TaggedWithFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TagPanePlugin:interface", "docComment": "/**\n * Internal plugin registration for the tag browser sidebar feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TagPanePlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TagPanePluginInstance", "canonicalReference": "obsidian-typings!TagPanePluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/tag-pane/TagPanePlugin.d.ts", "releaseTag": "Public", "name": "TagPanePlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TagPanePluginInstance:interface", "docComment": "/**\n * Plugin instance for the tag pane, displaying a browseable list of tags in the sidebar.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TagPanePluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TagPanePlugin", "canonicalReference": "obsidian-typings!TagPanePlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/tag-pane/TagPanePluginInstance.d.ts", "releaseTag": "Public", "name": "TagPanePluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TagPanePluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TagPanePluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TagPanePluginInstance#plugin:member", "docComment": "/**\n * Reference to the tag pane plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "TagPanePlugin", "canonicalReference": "obsidian-typings!TagPanePlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TagsPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for tags.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TagsPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/TagsPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "TagsPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TagsPropertyWidgetComponent#multiselect:member", "docComment": "/**\n * The multiselect component for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "multiselect: " }, { "kind": "Reference", "text": "Multiselect", "canonicalReference": "obsidian-typings!Multiselect:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "multiselect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagsPropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagsPropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TagsPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'tags'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TagView:interface", "docComment": "/**\n * View for browsing and navigating tags in the vault.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TagView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/TagView.d.ts", "releaseTag": "Public", "name": "TagView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagView#getNodeId:member(1)", "docComment": "/**\n * Get the identifier of a tag tree node.\n *\n * @param e - The tag tree node.\n *\n * @returns The node identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNodeId(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getNodeId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The view type identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Tag", "canonicalReference": "obsidian-typings!~__type#Tag:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagView#isItem:member(1)", "docComment": "/**\n * Check whether the given item is a valid tag view item.\n *\n * @param item - The item to check.\n *\n * @returns Whether the item is a valid tag view item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isItem(item: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagView#onKeyEnterInFocus:member(1)", "docComment": "/**\n * Handle pressing Enter on the currently focused tag item.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyEnterInFocus(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyEnterInFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagView#setIsAllCollapsed:member(1)", "docComment": "/**\n * Set whether all tag groups are collapsed.\n *\n * @param e - Whether all groups should be collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIsAllCollapsed(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setIsAllCollapsed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagView#setUseHierarchy:member(1)", "docComment": "/**\n * Set whether tags should be displayed in a nested hierarchy.\n *\n * @param e - Whether to use hierarchy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setUseHierarchy(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setUseHierarchy" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TagView#updateTags:member(1)", "docComment": "/**\n * Reloads all tags from vault, update all items and sort those.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateTags(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateTags" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TemplatesPlugin:interface", "docComment": "/**\n * Internal plugin registration for the templates feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TemplatesPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TemplatesPluginInstance", "canonicalReference": "obsidian-typings!TemplatesPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/templates/TemplatesPlugin.d.ts", "releaseTag": "Public", "name": "TemplatesPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TemplatesPluginInstance:interface", "docComment": "/**\n * Plugin instance for templates, providing template file insertion into notes.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TemplatesPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TemplatesPlugin", "canonicalReference": "obsidian-typings!TemplatesPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/templates/TemplatesPluginInstance.d.ts", "releaseTag": "Public", "name": "TemplatesPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TemplatesPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TemplatesPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TemplatesPluginInstance#plugin:member", "docComment": "/**\n * Reference to the templates plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "TemplatesPlugin", "canonicalReference": "obsidian-typings!TemplatesPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TEXT_GRADIENT:type", "docComment": "/**\n * Text gradient type constants.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TEXT_GRADIENT = " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TEXT_GRADIENT.d.ts", "releaseTag": "Public", "name": "TEXT_GRADIENT", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TextContent:interface", "docComment": "/**\n * Text content extracted from a PDF page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TextContent " } ], "fileUrlPath": "src/pdfjs-dist/internals/TextContent.d.ts", "releaseTag": "Public", "name": "TextContent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextContent#items:member", "docComment": "/**\n * Text items in the content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "TextItem", "canonicalReference": "obsidian-typings!TextItem:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextContent#styles:member", "docComment": "/**\n * Style definitions referenced by text items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "styles: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "PdfTextStyle", "canonicalReference": "obsidian-typings!PdfTextStyle:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "styles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextDirection:type", "docComment": "/**\n * The direction of the text.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextDirection = " }, { "kind": "Content", "text": "'auto' | 'ltr' | 'rtl'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/TextDirection.d.ts", "releaseTag": "Public", "name": "TextDirection", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TextItem:interface", "docComment": "/**\n * A single text item extracted from a PDF page.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TextItem " } ], "fileUrlPath": "src/pdfjs-dist/internals/TextItem.d.ts", "releaseTag": "Public", "name": "TextItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextItem#dir:member", "docComment": "/**\n * Text direction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dir: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dir", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextItem#fontName:member", "docComment": "/**\n * Font name reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextItem#hasEOL:member", "docComment": "/**\n * Whether this item has an end-of-line marker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasEOL: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hasEOL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextItem#height:member", "docComment": "/**\n * Height of the text item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextItem#str:member", "docComment": "/**\n * The text string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "str: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "str", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextItem#transform:member", "docComment": "/**\n * Transformation matrix for the text item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transform: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "transform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextItem#width:member", "docComment": "/**\n * Width of the text item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TextMarker:interface", "docComment": "/**\n * A text marker in a CodeMirror 5 document.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TextMarker " } ], "fileUrlPath": "src/codemirror/internals/TextMarker.d.ts", "releaseTag": "Public", "name": "TextMarker", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TextMarker#changed:member(1)", "docComment": "/**\n * Fired when the marked range changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changed(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "changed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TextMarker#clear:member(1)", "docComment": "/**\n * Clears the marker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TextMarker#find:member(1)", "docComment": "/**\n * Finds the current position of the marker.\n *\n * @returns The marker's range, or `undefined` if the marker has been cleared.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "find(): " }, { "kind": "Reference", "text": "TextMarkerRange", "canonicalReference": "obsidian-typings!TextMarkerRange:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "find" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TextMarker#off:member(1)", "docComment": "/**\n * Removes an event listener.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "off(eventName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TextMarker#on:member(1)", "docComment": "/**\n * Registers an event listener.\n *\n * @param eventName - The event name.\n *\n * @param handler - The handler to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(eventName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Content", "text": "(...args: unknown[]) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TextMarkerRange:interface", "docComment": "/**\n * The range of a text marker.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TextMarkerRange " } ], "fileUrlPath": "src/codemirror/internals/TextMarkerRange.d.ts", "releaseTag": "Public", "name": "TextMarkerRange", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextMarkerRange#from:member", "docComment": "/**\n * The start position of the marker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "from: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "from", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextMarkerRange#to:member", "docComment": "/**\n * The end position of the marker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "to: " }, { "kind": "Reference", "text": "Position", "canonicalReference": "obsidian-typings!Position:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "to", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for text.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TextPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/TextPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "TextPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#containerEl:member", "docComment": "/**\n * The container element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#ctx:member", "docComment": "/**\n * The render context for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ctx: " }, { "kind": "Reference", "text": "PropertyRenderContext", "canonicalReference": "obsidian-typings!PropertyRenderContext:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ctx", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#hoverPopover:member", "docComment": "/**\n * The hover popover for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hoverPopover: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hoverPopover", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#inputEl:member", "docComment": "/**\n * The input element for the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputEl: " }, { "kind": "Reference", "text": "HTMLInputElement", "canonicalReference": "!HTMLInputElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#onFocus:member(1)", "docComment": "/**\n * Handle focus event.\n *\n * @param mode - The focus mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFocus(mode?: " }, { "kind": "Reference", "text": "FocusMode", "canonicalReference": "obsidian-typings!FocusMode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mode", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "onFocus" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#render:member(1)", "docComment": "/**\n * Render the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#setValue:member(1)", "docComment": "/**\n * Set the value of the property widget.\n *\n * @param value - The value to set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setValue(value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setValue" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'text'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TextPropertyWidgetComponent#value:member", "docComment": "/**\n * The value of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "obsidian-typings!TextStyle:class", "docComment": "/**\n * Text style class.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TextStyle implements " }, { "kind": "Reference", "text": "ITextStyle", "canonicalReference": "obsidian-typings!ITextStyle:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/pixi.js/internals/TextStyle.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "TextStyle", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!TextStyle:constructor(1)", "docComment": "/**\n * Creates a new text style.\n *\n * @param style - The style parameters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(style?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ITextStyle", "canonicalReference": "obsidian-typings!ITextStyle:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "style", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#align:member", "docComment": "/**\n * Text alignment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "align: " }, { "kind": "Reference", "text": "TextStyleAlign", "canonicalReference": "obsidian-typings!TextStyleAlign:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "align", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#breakWords:member", "docComment": "/**\n * Whether to break words.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "breakWords: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "breakWords", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!TextStyle#clone:member(1)", "docComment": "/**\n * Clones this text style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clone(): " }, { "kind": "Reference", "text": "TextStyle", "canonicalReference": "obsidian-typings!TextStyle:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "clone" }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#dropShadow:member", "docComment": "/**\n * Whether to show a drop shadow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadow: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#dropShadowAlpha:member", "docComment": "/**\n * Drop shadow alpha.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowAlpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowAlpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#dropShadowAngle:member", "docComment": "/**\n * Drop shadow angle in radians.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowAngle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowAngle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#dropShadowBlur:member", "docComment": "/**\n * Drop shadow blur radius.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowBlur: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowBlur", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#dropShadowColor:member", "docComment": "/**\n * Drop shadow color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowColor: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#dropShadowDistance:member", "docComment": "/**\n * Drop shadow distance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dropShadowDistance: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dropShadowDistance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#fill:member", "docComment": "/**\n * Fill style for the text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fill: " }, { "kind": "Reference", "text": "TextStyleFill", "canonicalReference": "obsidian-typings!TextStyleFill:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fill", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#fillGradientStops:member", "docComment": "/**\n * Fill gradient stops.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fillGradientStops: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fillGradientStops", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#fillGradientType:member", "docComment": "/**\n * Fill gradient type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fillGradientType: " }, { "kind": "Reference", "text": "TEXT_GRADIENT", "canonicalReference": "obsidian-typings!TEXT_GRADIENT:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fillGradientType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#fontFamily:member", "docComment": "/**\n * Font family.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontFamily: " }, { "kind": "Content", "text": "string | string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontFamily", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#fontSize:member", "docComment": "/**\n * Font size.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontSize: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#fontStyle:member", "docComment": "/**\n * Font style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontStyle: " }, { "kind": "Reference", "text": "TextStyleFontStyle", "canonicalReference": "obsidian-typings!TextStyleFontStyle:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#fontVariant:member", "docComment": "/**\n * Font variant.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontVariant: " }, { "kind": "Reference", "text": "TextStyleFontVariant", "canonicalReference": "obsidian-typings!TextStyleFontVariant:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontVariant", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#fontWeight:member", "docComment": "/**\n * Font weight.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontWeight: " }, { "kind": "Reference", "text": "TextStyleFontWeight", "canonicalReference": "obsidian-typings!TextStyleFontWeight:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontWeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#leading:member", "docComment": "/**\n * Leading between lines.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "leading: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "leading", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#letterSpacing:member", "docComment": "/**\n * Letter spacing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "letterSpacing: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "letterSpacing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#lineHeight:member", "docComment": "/**\n * Line height.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineHeight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#lineJoin:member", "docComment": "/**\n * Line join style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineJoin: " }, { "kind": "Reference", "text": "TextStyleLineJoin", "canonicalReference": "obsidian-typings!TextStyleLineJoin:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineJoin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#miterLimit:member", "docComment": "/**\n * Miter limit.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "miterLimit: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "miterLimit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#padding:member", "docComment": "/**\n * Padding around the text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "padding: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "padding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!TextStyle#reset:member(1)", "docComment": "/**\n * Resets the text style to defaults.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reset(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "reset" }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#stroke:member", "docComment": "/**\n * Stroke color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stroke: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stroke", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#strokeThickness:member", "docComment": "/**\n * Stroke thickness.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "strokeThickness: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "strokeThickness", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#styleID:member", "docComment": "/**\n * Style ID for change tracking.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "styleID: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "styleID", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#textBaseline:member", "docComment": "/**\n * Text baseline.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textBaseline: " }, { "kind": "Reference", "text": "TextStyleTextBaseline", "canonicalReference": "obsidian-typings!TextStyleTextBaseline:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "textBaseline", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#trim:member", "docComment": "/**\n * Whether to trim whitespace.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "trim: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "trim", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#whiteSpace:member", "docComment": "/**\n * White space handling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "whiteSpace: " }, { "kind": "Reference", "text": "TextStyleWhiteSpace", "canonicalReference": "obsidian-typings!TextStyleWhiteSpace:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "whiteSpace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#wordWrap:member", "docComment": "/**\n * Whether to word wrap.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wordWrap: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wordWrap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!TextStyle#wordWrapWidth:member", "docComment": "/**\n * Word wrap width.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wordWrapWidth: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wordWrapWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextStyleAlign:type", "docComment": "/**\n * Text alignment options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextStyleAlign = " }, { "kind": "Content", "text": "'center' | 'justify' | 'left' | 'right'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TextStyleAlign.d.ts", "releaseTag": "Public", "name": "TextStyleAlign", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextStyleFill:type", "docComment": "/**\n * Text fill style type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextStyleFill = " }, { "kind": "Reference", "text": "CanvasGradient", "canonicalReference": "!CanvasGradient:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "CanvasPattern", "canonicalReference": "!CanvasPattern:interface" }, { "kind": "Content", "text": " | number | number[] | string | string[]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TextStyleFill.d.ts", "releaseTag": "Public", "name": "TextStyleFill", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextStyleFontStyle:type", "docComment": "/**\n * Font style options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextStyleFontStyle = " }, { "kind": "Content", "text": "'italic' | 'normal' | 'oblique'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TextStyleFontStyle.d.ts", "releaseTag": "Public", "name": "TextStyleFontStyle", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextStyleFontVariant:type", "docComment": "/**\n * Font variant options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextStyleFontVariant = " }, { "kind": "Content", "text": "'normal' | 'small-caps'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TextStyleFontVariant.d.ts", "releaseTag": "Public", "name": "TextStyleFontVariant", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextStyleFontWeight:type", "docComment": "/**\n * Font weight options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextStyleFontWeight = " }, { "kind": "Content", "text": "'100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900' | 'bold' | 'bolder' | 'lighter' | 'normal'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TextStyleFontWeight.d.ts", "releaseTag": "Public", "name": "TextStyleFontWeight", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextStyleLineJoin:type", "docComment": "/**\n * Line join options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextStyleLineJoin = " }, { "kind": "Content", "text": "'bevel' | 'miter' | 'round'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TextStyleLineJoin.d.ts", "releaseTag": "Public", "name": "TextStyleLineJoin", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextStyleTextBaseline:type", "docComment": "/**\n * Text baseline options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextStyleTextBaseline = " }, { "kind": "Content", "text": "'alphabetic' | 'bottom' | 'hanging' | 'ideographic' | 'middle' | 'top'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TextStyleTextBaseline.d.ts", "releaseTag": "Public", "name": "TextStyleTextBaseline", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TextStyleWhiteSpace:type", "docComment": "/**\n * White space handling options.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TextStyleWhiteSpace = " }, { "kind": "Content", "text": "'normal' | 'pre-line' | 'pre'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/pixi.js/internals/TextStyleWhiteSpace.d.ts", "releaseTag": "Public", "name": "TextStyleWhiteSpace", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Class", "canonicalReference": "obsidian-typings!Texture:class", "docComment": "/**\n * Texture resource.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Texture " } ], "fileUrlPath": "src/pixi.js/internals/Texture.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Texture", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!Texture.EMPTY:member", "docComment": "/**\n * An empty texture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static EMPTY: " }, { "kind": "Reference", "text": "Texture", "canonicalReference": "obsidian-typings!Texture:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "EMPTY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Texture.WHITE:member", "docComment": "/**\n * A white texture.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static WHITE: " }, { "kind": "Reference", "text": "Texture", "canonicalReference": "obsidian-typings!Texture:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "WHITE", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TFunction:type", "docComment": "/**\n * Translation function type for i18next.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TFunction = " }, { "kind": "Content", "text": "(key: string | string[], options?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>) => string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/i18next/internals/TFunction.d.ts", "releaseTag": "Public", "name": "TFunction", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ThemeManifest:interface", "docComment": "/**\n * Manifest metadata for an installed theme.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ThemeManifest " } ], "fileUrlPath": "src/obsidian/internals/ThemeManifest.d.ts", "releaseTag": "Public", "name": "ThemeManifest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ThemeManifest#author:member", "docComment": "/**\n * Name of the author of the theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "author: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "author", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ThemeManifest#authorUrl:member", "docComment": "/**\n * URL to the author's website.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authorUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "authorUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ThemeManifest#dir:member", "docComment": "/**\n * Storage location of the theme relative to the vault root.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dir: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "dir", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ThemeManifest#fundingUrl:member", "docComment": "/**\n * URL for funding the author.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fundingUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fundingUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ThemeManifest#minAppVersion:member", "docComment": "/**\n * Minimum Obsidian version compatible with the theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minAppVersion: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "minAppVersion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ThemeManifest#name:member", "docComment": "/**\n * Name of the theme.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ThemeManifest#version:member", "docComment": "/**\n * Version of the theme.\n *\n * @default\n *\n * `'0.0.0'`\n *\n * @remark\n *\n * Defaults to `'0.0.0'` if no theme manifest was provided in the repository.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "'0.0.0' | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TitleFunction:interface", "docComment": "/**\n * Function `Title`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TitleFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/TitleFunction.d.ts", "releaseTag": "Public", "name": "TitleFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Token:interface", "docComment": "/**\n * A clickable token in the editor with position, text, and type information.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Token extends " }, { "kind": "Reference", "text": "EditorRange", "canonicalReference": "obsidian!EditorRange:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/Token.d.ts", "releaseTag": "Public", "name": "Token", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Token#text:member", "docComment": "/**\n * Text content of the token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Token#type:member", "docComment": "/**\n * Type of the token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'external-link' | 'internal-link' | 'tag'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Function", "canonicalReference": "obsidian-typings!tokenize:function(1)", "docComment": "/**\n * Tokenizes a string of code using the given grammar.\n *\n * @param text - The code string to tokenize.\n *\n * @param grammar - The grammar to use for tokenization.\n *\n * @returns An array of strings and tokens.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function tokenize(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", grammar: " }, { "kind": "Reference", "text": "Grammar", "canonicalReference": "obsidian-typings!Grammar:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PrismToken", "canonicalReference": "obsidian-typings!PrismToken:class" }, { "kind": "Content", "text": " | string>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/prismjs/internals/functions/tokenize.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "grammar", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "tokenize" }, { "kind": "Class", "canonicalReference": "obsidian-typings!Transform:class", "docComment": "/**\n * Transform that holds position, scale, pivot, skew, and rotation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Transform " } ], "fileUrlPath": "src/pixi.js/internals/Transform.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Transform", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "obsidian-typings!Transform#localTransform:member", "docComment": "/**\n * Local transformation matrix.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "localTransform: " }, { "kind": "Reference", "text": "Matrix", "canonicalReference": "obsidian-typings!Matrix:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "localTransform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Transform#pivot:member", "docComment": "/**\n * Pivot point.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pivot: " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pivot", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Transform#position:member", "docComment": "/**\n * Position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "position: " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Transform#rotation:member", "docComment": "/**\n * Rotation in radians.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rotation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Transform#scale:member", "docComment": "/**\n * Scale.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale: " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Transform#skew:member", "docComment": "/**\n * Skew.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skew: " }, { "kind": "Reference", "text": "ObservablePoint", "canonicalReference": "obsidian-typings!ObservablePoint:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "skew", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "obsidian-typings!Transform#worldTransform:member", "docComment": "/**\n * World transformation matrix.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "worldTransform: " }, { "kind": "Reference", "text": "Matrix", "canonicalReference": "obsidian-typings!Matrix:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "worldTransform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!Tree:interface", "docComment": "/**\n * Hierarchical tree view UI component used for file explorers, search results, and similar views.\n *\n * @typeParam T - The type of tree item managed by this tree.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Tree<T extends " }, { "kind": "Reference", "text": "TreeItem", "canonicalReference": "obsidian-typings!TreeItem:interface" }, { "kind": "Content", "text": "> " } ], "fileUrlPath": "src/obsidian/internals/tree/Tree.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "Tree", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#activeDom:member", "docComment": "/**\n * Currently active item in tree view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "activeDom: " }, { "kind": "Content", "text": "null | T" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "activeDom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#changeFocusedItem:member(1)", "docComment": "/**\n * Change the focused item to the next item in specified direction.\n *\n * @param direction - The direction to move focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeFocusedItem(direction: " }, { "kind": "Content", "text": "'backwards' | 'forwards'" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "changeFocusedItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#clearSelectedDoms:member(1)", "docComment": "/**\n * Unselect all selected items in the tree view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearSelectedDoms(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearSelectedDoms" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#containerEl:member", "docComment": "/**\n * Container element of the tree view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "containerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#deselectItem:member(1)", "docComment": "/**\n * Mark tree item as deselected.\n *\n * @param node - The tree item to deselect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deselectItem(node: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "deselectItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#focusedItem:member", "docComment": "/**\n * Currently focused item in tree view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusedItem: " }, { "kind": "Content", "text": "null | T" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusedItem", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#getFoldKey:member(1)", "docComment": "/**\n * Get the local storage key for the saved tree view folds.\n *\n * @returns The local storage key string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFoldKey(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFoldKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#getNodeId:member(1)", "docComment": "/**\n * Gets the ID of a tree item given its Node.\n *\n * @param node - The tree item to get the ID for.\n *\n * @returns The node ID, or `undefined` if not found.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getNodeId(node: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getNodeId" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#handleCollapseAll:member(1)", "docComment": "/**\n * Handle collapsing of all nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleCollapseAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "handleCollapseAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#handleDeleteSelectedItems:member(1)", "docComment": "/**\n * Handle deletion of selected nodes.\n *\n * @param event - The keyboard event that triggered the deletion.\n *\n * @returns A promise that resolves when the selected items are deleted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleDeleteSelectedItems(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleDeleteSelectedItems" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#handleItemSelection:member(1)", "docComment": "/**\n * Handle selection of tree item via keyboard event.\n *\n * @param event - The mouse event that triggered the selection.\n *\n * @param node - The tree item being selected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleItemSelection(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": ", node: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "handleItemSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#handleRenameFocusedItem:member(1)", "docComment": "/**\n * Handle renaming of focused item.\n *\n * @param event - The keyboard event that triggered the rename.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleRenameFocusedItem(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "handleRenameFocusedItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#id:member", "docComment": "/**\n * ID of the view the tree is associated with.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#infinityScroll:member", "docComment": "/**\n * Facilitates rendering of tree view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "infinityScroll: " }, { "kind": "Reference", "text": "InfinityScroll", "canonicalReference": "obsidian-typings!InfinityScroll:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "infinityScroll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#initializeKeyboardNav:member(1)", "docComment": "/**\n * Registers all keyboard actions to the tree view keyscope.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "initializeKeyboardNav(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "initializeKeyboardNav" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#isAllCollapsed:member", "docComment": "/**\n * Whether all items in the tree are collapsed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isAllCollapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "isAllCollapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#isItem:member(1)", "docComment": "/**\n * Check whether item is a valid tree item.\n *\n * @param node - The item to check.\n *\n * @returns Whether the item is a valid tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isItem(node: " }, { "kind": "Content", "text": "T | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#loadFolds:member(1)", "docComment": "/**\n * Load the saved fold states of the tree view from local storage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadFolds(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadFolds" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#onKeyArrowDown:member(1)", "docComment": "/**\n * Handle keyboard event for moving/selecting tree item below.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyArrowDown(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyArrowDown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#onKeyArrowLeft:member(1)", "docComment": "/**\n * Handle keyboard event for moving through the hierarchy of tree items (and/or folding/unfolding).\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyArrowLeft(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyArrowLeft" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#onKeyArrowRight:member(1)", "docComment": "/**\n * Handle keyboard event for moving through the hierarchy of tree items (and/or folding/unfolding).\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyArrowRight(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyArrowRight" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#onKeyArrowUp:member(1)", "docComment": "/**\n * Handle keyboard event for moving/selecting tree item above.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyArrowUp(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyArrowUp" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#onKeyOpen:member(1)", "docComment": "/**\n * Handle keyboard event for opening tree item.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onKeyOpen(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onKeyOpen" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#onResize:member(1)", "docComment": "/**\n * Update scroll representation on resize.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onResize(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onResize" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#prefersCollapsed:member", "docComment": "/**\n * Whether tree items should default to collapsed state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prefersCollapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "prefersCollapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#requestSaveFolds:member(1)", "docComment": "/**\n * Request saving of the current fold states.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "requestSaveFolds(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "requestSaveFolds" }, { "kind": "Property", "canonicalReference": "obsidian-typings!Tree#root:member", "docComment": "/**\n * Root item of the tree view.\n *\n * @returns The root tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get root(): " }, { "kind": "Reference", "text": "TreeRoot", "canonicalReference": "obsidian-typings!TreeRoot:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "root", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#saveFolds:member(1)", "docComment": "/**\n * Save the current fold states of the tree view to local storage.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveFolds(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveFolds" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#scope:member", "docComment": "/**\n * Key scope for tree view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scope: " }, { "kind": "Reference", "text": "Scope", "canonicalReference": "obsidian!Scope:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#selectedDoms:member", "docComment": "/**\n * Currently selected items in tree view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedDoms: " }, { "kind": "Reference", "text": "Set", "canonicalReference": "!Set:interface" }, { "kind": "Content", "text": "<T>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selectedDoms", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#selectItem:member(1)", "docComment": "/**\n * Mark tree item as selected.\n *\n * @param node - The tree item to select.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectItem(node: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "selectItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#setCollapseAll:member(1)", "docComment": "/**\n * Set all items in the tree view to be collapsed or expanded.\n *\n * @param collapse - Whether to collapse all items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapseAll(collapse: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "collapse", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setCollapseAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#setFocusedItem:member(1)", "docComment": "/**\n * Set the focused item in the tree view.\n *\n * @param node - The tree item to focus.\n *\n * @param scrollIntoView - Whether to scroll the item into view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFocusedItem(node: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ", scrollIntoView?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "scrollIntoView", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "setFocusedItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!Tree#toggleCollapseAll:member(1)", "docComment": "/**\n * (Un)Collapse all items in the tree view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleCollapseAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleCollapseAll" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!Tree#view:member", "docComment": "/**\n * The view the tree is associated with.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "view: " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TreeCollapsibleItem:interface", "docComment": "/**\n * A tree item that can be collapsed to hide its children.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TreeCollapsibleItem extends " }, { "kind": "Reference", "text": "TreeItem", "canonicalReference": "obsidian-typings!TreeItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/tree/TreeCollapsibleItem.d.ts", "releaseTag": "Public", "name": "TreeCollapsibleItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#childrenEl:member", "docComment": "/**\n * Container element for the child items of this collapsible node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "childrenEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "childrenEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#collapsed:member", "docComment": "/**\n * Current collapsed state of tree item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapsed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapsed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#collapseEl:member", "docComment": "/**\n * Element for the collapse/expand toggle indicator, or `null` if not rendered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapseEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapseEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#collapsible:member", "docComment": "/**\n * Whether tree item is able to be collapsed or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "collapsible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "collapsible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#onCollapseClick:member(1)", "docComment": "/**\n * Execute collapse functionality on mouse click.\n *\n * @param event - The mouse click event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCollapseClick(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onCollapseClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#setCollapsed:member(1)", "docComment": "/**\n * Set collapsed state of tree item.\n *\n * @param value - Whether the item should be collapsed.\n *\n * @param animate - If set to `true`, will animate on collapse.\n *\n * @returns Resolves when the collapse state has been applied.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapsed(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", animate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<undefined>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "animate", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "setCollapsed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#setCollapsible:member(1)", "docComment": "/**\n * Set collapsible state of tree item.\n *\n * @param value - Whether the item should be collapsible.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCollapsible(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setCollapsible" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#toggleCollapsed:member(1)", "docComment": "/**\n * Toggle collapsed state of tree item.\n *\n * @param animate - If set to `true`, will animate on collapse.\n *\n * @returns Resolves when the collapse state has been toggled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleCollapsed(animate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<undefined>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "animate", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "toggleCollapsed" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeCollapsibleItem#updateCollapsed:member(1)", "docComment": "/**\n * Update the tree item's cover element.\n *\n * @param animate - If set to `true`, will animate on collapse.\n *\n * @returns Resolves when the cover element has been updated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateCollapsed(animate?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<undefined>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "animate", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "updateCollapsed" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TreeItem:interface", "docComment": "/**\n * Represents a single interactive item within a tree view UI component.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TreeItem extends " }, { "kind": "Reference", "text": "TreeNode", "canonicalReference": "obsidian-typings!TreeNode:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/tree/TreeItem.d.ts", "releaseTag": "Public", "name": "TreeItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeItem#coverEl:member", "docComment": "/**\n * Overlay element covering the tree item, used for visual effects.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "coverEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "coverEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeItem#innerEl:member", "docComment": "/**\n * Inner container element holding the tree item content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "innerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "innerEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeItem#onSelfClick:member(1)", "docComment": "/**\n * Execute item functionality on clicking tree item.\n *\n * @param event - The mouse click event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onSelfClick(event: " }, { "kind": "Reference", "text": "MouseEvent", "canonicalReference": "!MouseEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onSelfClick" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeItem#selfEl:member", "docComment": "/**\n * The main element representing this tree item in the DOM.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selfEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selfEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeItem#setClickable:member(1)", "docComment": "/**\n * Set clickable state of tree item.\n *\n * @param value - Whether the item should be clickable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setClickable(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setClickable" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TreeNode:interface", "docComment": "/**\n * {@link Tree} node.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TreeNode " } ], "fileUrlPath": "src/obsidian/internals/tree/TreeNode.d.ts", "releaseTag": "Public", "name": "TreeNode", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNode#el:member", "docComment": "/**\n * The element of the tree node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "el", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TreeNodeInfo:interface", "docComment": "/**\n * Layout information for a tree node used by the virtual scrolling system.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TreeNodeInfo " } ], "fileUrlPath": "src/obsidian/internals/tree/TreeNodeInfo.d.ts", "releaseTag": "Public", "name": "TreeNodeInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#childLeft:member", "docComment": "/**\n * Left offset of child elements in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "childLeft: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "childLeft", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#childLeftPadding:member", "docComment": "/**\n * Left padding applied to child elements in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "childLeftPadding: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "childLeftPadding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#childTop:member", "docComment": "/**\n * Top offset of child elements in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "childTop: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "childTop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#computed:member", "docComment": "/**\n * Whether layout dimensions have been computed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "computed: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "computed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#height:member", "docComment": "/**\n * Computed height of the node in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#hidden:member", "docComment": "/**\n * Whether the node is currently hidden from view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hidden: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hidden", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#next:member", "docComment": "/**\n * Whether there is a next sibling node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "next: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "next", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#queued:member", "docComment": "/**\n * Whether a layout recomputation is queued.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queued: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queued", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeInfo#width:member", "docComment": "/**\n * Computed width of the node in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TreeNodeVChildren:interface", "docComment": "/**\n * Manages the virtual children of a tree node for use with virtual scrolling.\n *\n * @typeParam Item - The type of the child items.\n *\n * @typeParam Owner - The type of the owner node.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TreeNodeVChildren<Item extends " }, { "kind": "Reference", "text": "TreeNode", "canonicalReference": "obsidian-typings!TreeNode:interface" }, { "kind": "Content", "text": ", Owner extends " }, { "kind": "Reference", "text": "TreeNode", "canonicalReference": "obsidian-typings!TreeNode:interface" }, { "kind": "Content", "text": "> " } ], "fileUrlPath": "src/obsidian/internals/tree/TreeNodeVChildren.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Item", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Owner", "constraintTokenRange": { "startIndex": 3, "endIndex": 4 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "TreeNodeVChildren", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#_children:member", "docComment": "/**\n * Internal array of child items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_children: " }, { "kind": "Content", "text": "Item[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "_children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#addChild:member(1)", "docComment": "/**\n * Add a child item to this node.\n *\n * @param item - The child item to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addChild(item: " }, { "kind": "Content", "text": "Item" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "addChild" }, { "kind": "Property", "canonicalReference": "obsidian-typings!TreeNodeVChildren#children:member", "docComment": "/**\n * Get the array of child items.\n *\n * @returns The child items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get children(): " }, { "kind": "Content", "text": "Item[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#clear:member(1)", "docComment": "/**\n * Remove all children from this node.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clear(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#first:member(1)", "docComment": "/**\n * Get the first child item, or `undefined` if there are no children.\n *\n * @returns The first child item, or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "first(): " }, { "kind": "Content", "text": "Item | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "first" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#hasChildren:member(1)", "docComment": "/**\n * Check whether this node has any children.\n *\n * @returns Whether the node has children.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasChildren(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hasChildren" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#last:member(1)", "docComment": "/**\n * Get the last child item, or `undefined` if there are no children.\n *\n * @returns The last child item, or `undefined`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "last(): " }, { "kind": "Content", "text": "Item | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "last" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#owner:member", "docComment": "/**\n * The tree node that owns these children.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "owner: " }, { "kind": "Content", "text": "Owner" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "owner", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#removeChild:member(1)", "docComment": "/**\n * Remove a specific child item from this node.\n *\n * @param item - The child item to remove.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeChild(item: " }, { "kind": "Content", "text": "Item" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeChild" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#setChildren:member(1)", "docComment": "/**\n * Replace all children with the given array.\n *\n * @param children - The new array of child items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setChildren(children: " }, { "kind": "Content", "text": "Item[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "children", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setChildren" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#size:member(1)", "docComment": "/**\n * Get the number of children.\n *\n * @returns The number of child items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "size" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TreeNodeVChildren#sort:member(1)", "docComment": "/**\n * Sort the children using the provided comparison function.\n *\n * @param compareFn - The comparison function for sorting.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sort(compareFn: " }, { "kind": "Content", "text": "(a: Item, b: Item) => number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "compareFn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "sort" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TreeRoot:interface", "docComment": "/**\n * Root node of a tree view that contains all top-level tree items.\n *\n * @typeParam Item - The type of the tree items.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TreeRoot<Item extends " }, { "kind": "Reference", "text": "TreeItem", "canonicalReference": "obsidian-typings!TreeItem:interface" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "TreeNode", "canonicalReference": "obsidian-typings!TreeNode:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/tree/TreeRoot.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Item", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "TreeRoot", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeRoot#childrenEl:member", "docComment": "/**\n * Container element for the root's child items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "childrenEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "childrenEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeRoot#info:member", "docComment": "/**\n * Layout information for the root node used by virtual scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "info: " }, { "kind": "Reference", "text": "TreeNodeInfo", "canonicalReference": "obsidian-typings!TreeNodeInfo:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "info", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeRoot#pusherEl:member", "docComment": "/**\n * Spacer element used to maintain correct scroll height for virtual scrolling.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pusherEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pusherEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TreeRoot#vChildren:member", "docComment": "/**\n * Virtual children manager for the root's child items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vChildren: " }, { "kind": "Reference", "text": "TreeNodeVChildren", "canonicalReference": "obsidian-typings!TreeNodeVChildren:interface" }, { "kind": "Content", "text": "<Item, " }, { "kind": "Reference", "text": "TreeRoot", "canonicalReference": "obsidian-typings!TreeRoot:interface" }, { "kind": "Content", "text": "<Item>>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vChildren", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TrimFunction:interface", "docComment": "/**\n * Function `Trim`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TrimFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/TrimFunction.d.ts", "releaseTag": "Public", "name": "TrimFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TryResolveFileParams:interface", "docComment": "/**\n * Parameters for trying to resolve a file.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TryResolveFileParams " } ], "fileUrlPath": "src/obsidian/internals/cli/TryResolveFileParams.d.ts", "releaseTag": "Public", "name": "TryResolveFileParams", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TryResolveFileParams#file:member", "docComment": "/**\n * The file to resolve.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "file?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "file", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TryResolveFileParams#path:member", "docComment": "/**\n * The path to the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "obsidian-typings!TurndownService_2:class", "docComment": "/**\n * Converts HTML to Markdown.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TurndownService " } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownService.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "TurndownService_2", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "obsidian-typings!TurndownService_2:constructor(1)", "docComment": "/**\n * Create new instance of {@link TurndownService}.\n *\n * @param options - Options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options?: " }, { "kind": "Reference", "text": "TurndownServiceOptions", "canonicalReference": "obsidian-typings!TurndownServiceOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "obsidian-typings!TurndownService_2#addRule:member(1)", "docComment": "/**\n * Add a conversion rule.\n *\n * @param key - Rule identifier.\n *\n * @param rule - The rule definition.\n *\n * @returns This instance for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addRule(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", rule: " }, { "kind": "Reference", "text": "TurndownServiceRule", "canonicalReference": "obsidian-typings!TurndownServiceRule:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "rule", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "addRule" }, { "kind": "Method", "canonicalReference": "obsidian-typings!TurndownService_2#escape:member(1)", "docComment": "/**\n * Escape a string for use in Markdown.\n *\n * @param str - The string to escape.\n *\n * @returns The escaped string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "escape(str: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "str", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "escape" }, { "kind": "Method", "canonicalReference": "obsidian-typings!TurndownService_2#keep:member(1)", "docComment": "/**\n * Keep elements matching a filter (pass through as HTML).\n *\n * @param filter - The filter to match.\n *\n * @returns This instance for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keep(filter: " }, { "kind": "Reference", "text": "TurndownServiceFilter", "canonicalReference": "obsidian-typings!TurndownServiceFilter:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "keep" }, { "kind": "Property", "canonicalReference": "obsidian-typings!TurndownService_2#options:member", "docComment": "/**\n * Current conversion options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "TurndownServiceOptions", "canonicalReference": "obsidian-typings!TurndownServiceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!TurndownService_2#remove:member(1)", "docComment": "/**\n * Remove elements matching a filter from output.\n *\n * @param filter - The filter to match.\n *\n * @returns This instance for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(filter: " }, { "kind": "Reference", "text": "TurndownServiceFilter", "canonicalReference": "obsidian-typings!TurndownServiceFilter:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "remove" }, { "kind": "Property", "canonicalReference": "obsidian-typings!TurndownService_2#rules:member", "docComment": "/**\n * Collection of conversion rules.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rules: " }, { "kind": "Reference", "text": "TurndownServiceRules", "canonicalReference": "obsidian-typings!TurndownServiceRules:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rules", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "obsidian-typings!TurndownService_2#turndown:member(1)", "docComment": "/**\n * Convert HTML to Markdown.\n *\n * @param html - HTML string or DOM node to convert.\n *\n * @returns The Markdown string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "turndown(html: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "TurndownServiceNode", "canonicalReference": "obsidian-typings!TurndownServiceNode:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "html", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "turndown" }, { "kind": "Method", "canonicalReference": "obsidian-typings!TurndownService_2#use:member(1)", "docComment": "/**\n * Register plugin(s).\n *\n * @param plugins - Plugin or array of plugins.\n *\n * @returns This instance for chaining.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "use(plugins: " }, { "kind": "Reference", "text": "TurndownServicePlugin", "canonicalReference": "obsidian-typings!TurndownServicePlugin:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "TurndownServicePlugin", "canonicalReference": "obsidian-typings!TurndownServicePlugin:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "plugins", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "use" } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TurndownServiceFilter:type", "docComment": "/**\n * A filter that matches HTML elements by tag name(s) or a custom function.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TurndownServiceFilter = " }, { "kind": "Reference", "text": "TurndownServiceFilterFunction", "canonicalReference": "obsidian-typings!TurndownServiceFilterFunction:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "TurndownServiceTagName", "canonicalReference": "obsidian-typings!TurndownServiceTagName:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "TurndownServiceTagName", "canonicalReference": "obsidian-typings!TurndownServiceTagName:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServiceFilter.d.ts", "releaseTag": "Public", "name": "TurndownServiceFilter", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TurndownServiceFilterFunction:type", "docComment": "/**\n * Function that tests whether a node matches a filter.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TurndownServiceFilterFunction = " }, { "kind": "Content", "text": "(node: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "TurndownServiceOptions", "canonicalReference": "obsidian-typings!TurndownServiceOptions:interface" }, { "kind": "Content", "text": ") => boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServiceFilterFunction.d.ts", "releaseTag": "Public", "name": "TurndownServiceFilterFunction", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TurndownServiceNode:type", "docComment": "/**\n * Input node type accepted by TurndownService.turndown().\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TurndownServiceNode = " }, { "kind": "Reference", "text": "Document", "canonicalReference": "!Document:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DocumentFragment", "canonicalReference": "!DocumentFragment:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServiceNode.d.ts", "releaseTag": "Public", "name": "TurndownServiceNode", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TurndownServiceOptions:interface", "docComment": "/**\n * Configuration options for TurndownService.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TurndownServiceOptions " } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServiceOptions.d.ts", "releaseTag": "Public", "name": "TurndownServiceOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#blankReplacement:member", "docComment": "/**\n * Custom replacement function for blank nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blankReplacement?: " }, { "kind": "Reference", "text": "TurndownServiceReplacementFunction", "canonicalReference": "obsidian-typings!TurndownServiceReplacementFunction:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "blankReplacement", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#br:member", "docComment": "/**\n * Line break replacement string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "br?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "br", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#bulletListMarker:member", "docComment": "/**\n * Bullet list marker character.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bulletListMarker?: " }, { "kind": "Content", "text": "'-' | '*' | '+'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "bulletListMarker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#codeBlockStyle:member", "docComment": "/**\n * Code block style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "codeBlockStyle?: " }, { "kind": "Content", "text": "'fenced' | 'indented'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "codeBlockStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#defaultReplacement:member", "docComment": "/**\n * Custom default replacement function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultReplacement?: " }, { "kind": "Reference", "text": "TurndownServiceReplacementFunction", "canonicalReference": "obsidian-typings!TurndownServiceReplacementFunction:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultReplacement", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#emDelimiter:member", "docComment": "/**\n * Emphasis delimiter character.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "emDelimiter?: " }, { "kind": "Content", "text": "'_' | '*'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "emDelimiter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#fence:member", "docComment": "/**\n * Fence delimiter string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fence?: " }, { "kind": "Content", "text": "'```' | '~~~'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "fence", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#headingStyle:member", "docComment": "/**\n * Heading style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headingStyle?: " }, { "kind": "Content", "text": "'atx' | 'setext'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "headingStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#hr:member", "docComment": "/**\n * Horizontal rule replacement string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hr?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "hr", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#keepReplacement:member", "docComment": "/**\n * Custom replacement function for kept elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keepReplacement?: " }, { "kind": "Reference", "text": "TurndownServiceReplacementFunction", "canonicalReference": "obsidian-typings!TurndownServiceReplacementFunction:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "keepReplacement", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#linkReferenceStyle:member", "docComment": "/**\n * Link reference style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linkReferenceStyle?: " }, { "kind": "Content", "text": "'collapsed' | 'full' | 'shortcut'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "linkReferenceStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#linkStyle:member", "docComment": "/**\n * Link style.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "linkStyle?: " }, { "kind": "Content", "text": "'inlined' | 'referenced'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "linkStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#preformattedCode:member", "docComment": "/**\n * Whether to use preformatted code blocks.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preformattedCode?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "preformattedCode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceOptions#strongDelimiter:member", "docComment": "/**\n * Strong delimiter string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "strongDelimiter?: " }, { "kind": "Content", "text": "'__' | '**'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "strongDelimiter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TurndownServicePlugin:type", "docComment": "/**\n * A plugin function that extends TurndownService.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TurndownServicePlugin = " }, { "kind": "Content", "text": "(service: " }, { "kind": "Reference", "text": "TurndownService", "canonicalReference": "obsidian-typings!TurndownService_2:class" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServicePlugin.d.ts", "releaseTag": "Public", "name": "TurndownServicePlugin", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TurndownServiceReplacementFunction:type", "docComment": "/**\n * Function that converts an HTML element's content to Markdown.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TurndownServiceReplacementFunction = " }, { "kind": "Content", "text": "(content: string, node: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", options: " }, { "kind": "Reference", "text": "TurndownServiceOptions", "canonicalReference": "obsidian-typings!TurndownServiceOptions:interface" }, { "kind": "Content", "text": ") => string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServiceReplacementFunction.d.ts", "releaseTag": "Public", "name": "TurndownServiceReplacementFunction", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TurndownServiceRule:interface", "docComment": "/**\n * A rule that defines how to convert specific HTML elements to Markdown.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TurndownServiceRule " } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServiceRule.d.ts", "releaseTag": "Public", "name": "TurndownServiceRule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceRule#filter:member", "docComment": "/**\n * Filter to match HTML elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filter: " }, { "kind": "Reference", "text": "TurndownServiceFilter", "canonicalReference": "obsidian-typings!TurndownServiceFilter:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceRule#replacement:member", "docComment": "/**\n * Function that converts the matched element to Markdown.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "replacement?: " }, { "kind": "Reference", "text": "TurndownServiceReplacementFunction", "canonicalReference": "obsidian-typings!TurndownServiceReplacementFunction:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "replacement", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TurndownServiceRules:interface", "docComment": "/**\n * Collection of rules used by TurndownService for HTML-to-Markdown conversion.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TurndownServiceRules " } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServiceRules.d.ts", "releaseTag": "Public", "name": "TurndownServiceRules", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#add:member(1)", "docComment": "/**\n * Add a rule.\n *\n * @param key - Rule identifier.\n *\n * @param rule - The rule to add.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add(key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", rule: " }, { "kind": "Reference", "text": "TurndownServiceRule", "canonicalReference": "obsidian-typings!TurndownServiceRule:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "rule", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "add" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#array:member", "docComment": "/**\n * Array of registered rules.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "array: " }, { "kind": "Reference", "text": "TurndownServiceRule", "canonicalReference": "obsidian-typings!TurndownServiceRule:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "array", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#blankRule:member", "docComment": "/**\n * Replacement function for blank nodes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "blankRule: " }, { "kind": "Reference", "text": "TurndownServiceReplacementFunction", "canonicalReference": "obsidian-typings!TurndownServiceReplacementFunction:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "blankRule", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#defaultRule:member", "docComment": "/**\n * Default replacement function when no rule matches.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultRule: " }, { "kind": "Reference", "text": "TurndownServiceReplacementFunction", "canonicalReference": "obsidian-typings!TurndownServiceReplacementFunction:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultRule", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#forEach:member(1)", "docComment": "/**\n * Iterate over all rules.\n *\n * @param callback - Called for each rule.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forEach(callback: " }, { "kind": "Content", "text": "(rule: " }, { "kind": "Reference", "text": "TurndownServiceRule", "canonicalReference": "obsidian-typings!TurndownServiceRule:interface" }, { "kind": "Content", "text": ", index: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "forEach" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#forNode:member(1)", "docComment": "/**\n * Find the matching rule for a node.\n *\n * @param node - The HTML element to match.\n *\n * @returns The matching rule.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forNode(node: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TurndownServiceRule", "canonicalReference": "obsidian-typings!TurndownServiceRule:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "node", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "forNode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#keep:member(1)", "docComment": "/**\n * Keep elements matching a filter (pass through as HTML).\n *\n * @param filter - The filter to match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keep(filter: " }, { "kind": "Reference", "text": "TurndownServiceFilter", "canonicalReference": "obsidian-typings!TurndownServiceFilter:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "keep" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#keepReplacement:member", "docComment": "/**\n * Replacement function for kept elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keepReplacement: " }, { "kind": "Reference", "text": "TurndownServiceReplacementFunction", "canonicalReference": "obsidian-typings!TurndownServiceReplacementFunction:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keepReplacement", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#options:member", "docComment": "/**\n * Current rule options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Reference", "text": "TurndownServiceOptions", "canonicalReference": "obsidian-typings!TurndownServiceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!TurndownServiceRules#remove:member(1)", "docComment": "/**\n * Remove elements matching a filter from output.\n *\n * @param filter - The filter to match.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(filter: " }, { "kind": "Reference", "text": "TurndownServiceFilter", "canonicalReference": "obsidian-typings!TurndownServiceFilter:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "remove" } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TurndownServiceTagName:type", "docComment": "/**\n * Tag name filter.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TurndownServiceTagName = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/turndown/internals/TurndownService/TurndownServiceTagName.d.ts", "releaseTag": "Public", "name": "TurndownServiceTagName", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!TypedViewCreator:type", "docComment": "/**\n * Factory function type that creates a typed view instance for a given workspace leaf.\n *\n * @typeParam TView - The type of the view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TypedViewCreator<TView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ") => TView" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/views/TypedViewCreator.d.ts", "releaseTag": "Public", "name": "TypedViewCreator", "typeParameters": [ { "typeParameterName": "TView", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TypedWorkspaceLeaf:interface", "docComment": "/**\n * A workspace leaf with a strongly typed view.\n *\n * @typeParam TView - The type of the view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TypedWorkspaceLeaf<TView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/TypedWorkspaceLeaf.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TView", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "TypedWorkspaceLeaf", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TypedWorkspaceLeaf#view:member", "docComment": "/**\n * The typed view attached to this leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "view: " }, { "kind": "Reference", "text": "MaybeDeferredView", "canonicalReference": "obsidian-typings!MaybeDeferredView:type" }, { "kind": "Content", "text": "<TView>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "view", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!TypeInfo:interface", "docComment": "/**\n * Information about a property's expected and inferred widget types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TypeInfo " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/TypeInfo.d.ts", "releaseTag": "Public", "name": "TypeInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TypeInfo#expected:member", "docComment": "/**\n * The explicitly assigned property widget type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "expected: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "expected", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!TypeInfo#inferred:member", "docComment": "/**\n * The property widget type inferred from the value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inferred: " }, { "kind": "Reference", "text": "PropertyWidget", "canonicalReference": "obsidian-typings!PropertyWidget:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inferred", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!UIEventConstructor:type", "docComment": "/**\n * UIEvent constructor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type UIEventConstructor<T> = " }, { "kind": "Reference", "text": "ConstructorBase", "canonicalReference": "obsidian-typings!ConstructorBase:interface" }, { "kind": "Content", "text": "<unknown[], T>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/constructors/UIEventConstructor.d.ts", "releaseTag": "Public", "name": "UIEventConstructor", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!UniqueFunction:interface", "docComment": "/**\n * Function `Unique`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface UniqueFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/UniqueFunction.d.ts", "releaseTag": "Public", "name": "UniqueFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!UnknownPropertyWidgetComponent:interface", "docComment": "/**\n * Property widget component for unknown types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface UnknownPropertyWidgetComponent extends " }, { "kind": "Reference", "text": "PropertyWidgetComponentBase", "canonicalReference": "obsidian-typings!PropertyWidgetComponentBase:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/metadata-type-manager/UnknownPropertyWidgetComponent.d.ts", "releaseTag": "Public", "name": "UnknownPropertyWidgetComponent", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!UnknownPropertyWidgetComponent#el:member", "docComment": "/**\n * The element of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "el: " }, { "kind": "Reference", "text": "HTMLSpanElement", "canonicalReference": "!HTMLSpanElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "el", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!UnknownPropertyWidgetComponent#type:member", "docComment": "/**\n * The type of the property widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'unknown'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!UnknownView:interface", "docComment": "/**\n * Views of plugins that have been deactivated become an {@link UnknownView}.\n *\n * @remark\n *\n * This is probably not the right term.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface UnknownView extends " }, { "kind": "Reference", "text": "EmptyView", "canonicalReference": "obsidian-typings!EmptyView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/UnknownView.d.ts", "releaseTag": "Public", "name": "UnknownView", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!UrlBookmarkItem:interface", "docComment": "/**\n * {@link Bookmark} item representing a bookmarked URL.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface UrlBookmarkItem extends " }, { "kind": "Reference", "text": "BookmarkItem", "canonicalReference": "obsidian-typings!BookmarkItem:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bookmarks/bookmark-items/UrlBookmarkItem.d.ts", "releaseTag": "Public", "name": "UrlBookmarkItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!UrlBookmarkItem#title:member", "docComment": "/**\n * Display title of this URL bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!UrlBookmarkItem#type:member", "docComment": "/**\n * Discriminator indicating this is a URL bookmark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'url'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!UrlBookmarkItem#url:member", "docComment": "/**\n * The bookmarked URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!use:var", "docComment": "/**\n * Registers a plugin module.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "use: " }, { "kind": "Reference", "text": "I18n", "canonicalReference": "obsidian-typings!I18n:interface" }, { "kind": "Content", "text": "['use']" } ], "fileUrlPath": "src/i18next/internals/functions/use.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "use", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Variable", "canonicalReference": "obsidian-typings!util:var", "docComment": "/**\n * Prism utility functions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "util: " }, { "kind": "Reference", "text": "PrismUtil", "canonicalReference": "obsidian-typings!PrismUtil:interface" } ], "fileUrlPath": "src/prismjs/internals/vars/util.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "util", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VaultFileMapRecord:interface", "docComment": "/**\n * Record mapping file paths to their {@link obsidian#TAbstractFile} instances in the vault.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VaultFileMapRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/VaultFileMapRecord.d.ts", "releaseTag": "Public", "name": "VaultFileMapRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!version:var", "docComment": "/**\n * The CodeMirror 5 version string.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/codemirror/internals/vars/version.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "version", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VideoView:interface", "docComment": "/**\n * View for rendering and playing video files.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VideoView extends " }, { "kind": "Reference", "text": "EditableFileView", "canonicalReference": "obsidian!EditableFileView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/views/VideoView.d.ts", "releaseTag": "Public", "name": "VideoView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VideoView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The view type identifier.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Video", "canonicalReference": "obsidian-typings!~__type#Video:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ViewEphemeralState:interface", "docComment": "/**\n * Ephemeral state for a view, storing cursor position and focus information.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ViewEphemeralState " } ], "fileUrlPath": "src/obsidian/internals/ViewEphemeralState.d.ts", "releaseTag": "Public", "name": "ViewEphemeralState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewEphemeralState#cursor:member", "docComment": "/**\n * Cursor position or selection range in the editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cursor?: " }, { "kind": "Reference", "text": "EditorRangeOrCaret", "canonicalReference": "obsidian!EditorRangeOrCaret:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cursor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewEphemeralState#focus:member", "docComment": "/**\n * Whether the view should receive focus.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focus", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewEphemeralState#focusOnMobile:member", "docComment": "/**\n * Whether the view should receive focus on mobile (may show keyboard).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusOnMobile: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusOnMobile", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ViewFactory:type", "docComment": "/**\n * {@link obsidian#View} factory.\n *\n * @typeParam TView - The type of the view.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ViewFactory<TView extends " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "View", "canonicalReference": "obsidian!View:class" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "(containerEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ") => TView" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/ViewFactory.d.ts", "releaseTag": "Public", "name": "ViewFactory", "typeParameters": [ { "typeParameterName": "TView", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 8 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ViewRegistry:interface", "docComment": "/**\n * Registry that maps view types to their constructors and file extensions to view types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ViewRegistry extends " }, { "kind": "Reference", "text": "Events", "canonicalReference": "obsidian!Events:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/view-registry/ViewRegistry.d.ts", "releaseTag": "Public", "name": "ViewRegistry", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getViewRegistryConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#getTypeByExtension:member(1)", "docComment": "/**\n * Get the view type associated with a file extension.\n *\n * @param extension - File extension.\n *\n * @returns The view type string, or `undefined` if not registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTypeByExtension(extension: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extension", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getTypeByExtension" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#getViewCreatorByType:member(1)", "docComment": "/**\n * Get the view creator function associated with a view type.\n *\n * @param type - The view type identifier.\n *\n * @returns The view creator function, or `undefined` if not registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewCreatorByType(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "undefined | " }, { "kind": "Reference", "text": "ViewCreator", "canonicalReference": "obsidian!ViewCreator:type" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getViewCreatorByType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#getViewCreatorByType:member(2)", "docComment": "/**\n * Get the view constructor associated with a view type.\n *\n * @param type - The view type identifier.\n *\n * @returns The typed view creator function, or `undefined` if not registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewCreatorByType<TViewType extends " }, { "kind": "Reference", "text": "ViewTypeType", "canonicalReference": "obsidian-typings!ViewTypeType:type" }, { "kind": "Content", "text": ">(\n type: " }, { "kind": "Content", "text": "TViewType" }, { "kind": "Content", "text": "\n ): " }, { "kind": "Reference", "text": "TypedViewCreator", "canonicalReference": "obsidian-typings!TypedViewCreator:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ViewTypeViewMapping", "canonicalReference": "obsidian-typings!ViewTypeViewMapping:type" }, { "kind": "Content", "text": "[TViewType]> | undefined" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "TViewType", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "getViewCreatorByType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#isExtensionRegistered:member(1)", "docComment": "/**\n * Check whether a view type is registered.\n *\n * @param extension - The file extension to check.\n *\n * @returns Whether the extension is registered.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isExtensionRegistered(extension: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extension", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isExtensionRegistered" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#on:member(1)", "docComment": "/**\n * Called when the file extensions mapping has been updated.\n *\n * @param name - The event name.\n *\n * @param callback - The callback to invoke.\n *\n * @returns The event reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(name: " }, { "kind": "Content", "text": "'extensions-updated'" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EventRef", "canonicalReference": "obsidian!EventRef:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#on:member(2)", "docComment": "/**\n * Called when a view of type has been registered into the registry.\n *\n * @param name - The event name.\n *\n * @param callback - The callback to invoke with the registered view type.\n *\n * @returns The event reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(name: " }, { "kind": "Content", "text": "'view-registered'" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(viewType: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EventRef", "canonicalReference": "obsidian!EventRef:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#on:member(3)", "docComment": "/**\n * Called when a view of type has been unregistered from the registry.\n *\n * @param name - The event name.\n *\n * @param callback - The callback to invoke with the unregistered view type.\n *\n * @returns The event reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "on(name: " }, { "kind": "Content", "text": "'view-unregistered'" }, { "kind": "Content", "text": ", callback: " }, { "kind": "Content", "text": "(viewType: string) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "EventRef", "canonicalReference": "obsidian!EventRef:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#registerExtensions:member(1)", "docComment": "/**\n * Register a view type for file extensions.\n *\n * @param extensions - File extensions.\n *\n * @param viewType - View type.\n *\n * @remark\n *\n * Prefer registering the extensions via the Plugin class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerExtensions(extensions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", viewType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extensions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "viewType", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "registerExtensions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#registerView:member(1)", "docComment": "/**\n * Register a view constructor for a view type.\n *\n * @param type - The view type identifier.\n *\n * @param viewCreator - The view creator function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerView(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", viewCreator: " }, { "kind": "Reference", "text": "ViewCreator", "canonicalReference": "obsidian!ViewCreator:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "viewCreator", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "registerView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#registerViewWithExtensions:member(1)", "docComment": "/**\n * Register a view and its associated file extensions.\n *\n * @param extensions - The file extensions to register.\n *\n * @param type - The view type identifier.\n *\n * @param viewCreator - The view creator function.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerViewWithExtensions(extensions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", viewCreator: " }, { "kind": "Reference", "text": "ViewCreator", "canonicalReference": "obsidian!ViewCreator:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extensions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "viewCreator", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "registerViewWithExtensions" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistry#typeByExtension:member", "docComment": "/**\n * Mapping of file extensions to view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "typeByExtension: " }, { "kind": "Reference", "text": "ViewRegistryTypeByExtensionRecord", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "typeByExtension", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#unregisterExtensions:member(1)", "docComment": "/**\n * Unregister extensions for a view type.\n *\n * @param extensions - The file extensions to unregister.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unregisterExtensions(extensions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "extensions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unregisterExtensions" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!ViewRegistry#unregisterView:member(1)", "docComment": "/**\n * Unregister a view type.\n *\n * @param type - The view type identifier to unregister.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unregisterView(type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "unregisterView" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistry#viewByType:member", "docComment": "/**\n * Mapping of view type to view constructor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "viewByType: " }, { "kind": "Reference", "text": "ViewRegistryViewByTypeRecord", "canonicalReference": "obsidian-typings!ViewRegistryViewByTypeRecord:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewByType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord:interface", "docComment": "/**\n * Record mapping file extensions to their default view types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ViewRegistryTypeByExtensionRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, string>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/view-registry/ViewRegistryTypeByExtensionRecord.d.ts", "releaseTag": "Public", "name": "ViewRegistryTypeByExtensionRecord", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#\"3gp\":member", "docComment": "/**\n * Maps .3gp files to the audio view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension._3gp", "canonicalReference": "obsidian-typings!~__type#_3gp" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\"3gp\"", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#avif:member", "docComment": "/**\n * Maps .avif files to the image view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.avif", "canonicalReference": "obsidian-typings!~__type#avif" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "avif", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#bmp:member", "docComment": "/**\n * Maps .bmp files to the image view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.bmp", "canonicalReference": "obsidian-typings!~__type#bmp" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "bmp", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#canvas:member", "docComment": "/**\n * Maps .canvas files to the canvas view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.canvas", "canonicalReference": "obsidian-typings!~__type#canvas" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Canvas", "canonicalReference": "obsidian-typings!~__type#Canvas:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "canvas", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#flac:member", "docComment": "/**\n * Maps .flac files to the audio view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.flac", "canonicalReference": "obsidian-typings!~__type#flac" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "flac", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#gif:member", "docComment": "/**\n * Maps .gif files to the image view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.gif", "canonicalReference": "obsidian-typings!~__type#gif" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "gif", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#jpeg:member", "docComment": "/**\n * Maps .jpeg files to the image view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.jpeg", "canonicalReference": "obsidian-typings!~__type#jpeg" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "jpeg", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#jpg:member", "docComment": "/**\n * Maps .jpg files to the image view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.jpg", "canonicalReference": "obsidian-typings!~__type#jpg" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "jpg", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#m4a:member", "docComment": "/**\n * Maps .m4a files to the audio view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.m4a", "canonicalReference": "obsidian-typings!~__type#m4a" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "m4a", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#md:member", "docComment": "/**\n * Maps .md files to the markdown view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.md", "canonicalReference": "obsidian-typings!~__type#md" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Markdown", "canonicalReference": "obsidian-typings!~__type#Markdown:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "md", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#mkv:member", "docComment": "/**\n * Maps .mkv files to the video view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.mkv", "canonicalReference": "obsidian-typings!~__type#mkv" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Video", "canonicalReference": "obsidian-typings!~__type#Video:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mkv", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#mov:member", "docComment": "/**\n * Maps .mov files to the video view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.mov", "canonicalReference": "obsidian-typings!~__type#mov" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Video", "canonicalReference": "obsidian-typings!~__type#Video:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mov", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#mp3:member", "docComment": "/**\n * Maps .mp3 files to the audio view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.mp3", "canonicalReference": "obsidian-typings!~__type#mp3" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mp3", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#mp4:member", "docComment": "/**\n * Maps .mp4 files to the video view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.mp4", "canonicalReference": "obsidian-typings!~__type#mp4" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Video", "canonicalReference": "obsidian-typings!~__type#Video:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "mp4", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#oga:member", "docComment": "/**\n * Maps .oga files to the audio view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.oga", "canonicalReference": "obsidian-typings!~__type#oga" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "oga", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#ogg:member", "docComment": "/**\n * Maps .ogg files to the audio view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.ogg", "canonicalReference": "obsidian-typings!~__type#ogg" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ogg", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#ogv:member", "docComment": "/**\n * Maps .ogv files to the video view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.ogv", "canonicalReference": "obsidian-typings!~__type#ogv" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Video", "canonicalReference": "obsidian-typings!~__type#Video:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ogv", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#opus:member", "docComment": "/**\n * Maps .opus files to the audio view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.opus", "canonicalReference": "obsidian-typings!~__type#opus" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "opus", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#pdf:member", "docComment": "/**\n * Maps .pdf files to the PDF view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.pdf", "canonicalReference": "obsidian-typings!~__type#pdf" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Pdf", "canonicalReference": "obsidian-typings!~__type#Pdf:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pdf", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#png:member", "docComment": "/**\n * Maps .png files to the image view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.png", "canonicalReference": "obsidian-typings!~__type#png" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "png", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#svg:member", "docComment": "/**\n * Maps .svg files to the image view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.svg", "canonicalReference": "obsidian-typings!~__type#svg" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "svg", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#wav:member", "docComment": "/**\n * Maps .wav files to the audio view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.wav", "canonicalReference": "obsidian-typings!~__type#wav" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "wav", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#webm:member", "docComment": "/**\n * Maps .webm files to the video view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.webm", "canonicalReference": "obsidian-typings!~__type#webm" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Video", "canonicalReference": "obsidian-typings!~__type#Video:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webm", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ViewRegistryTypeByExtensionRecord#webp:member", "docComment": "/**\n * Maps .webp files to the image view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "FileExtension.webp", "canonicalReference": "obsidian-typings!~__type#webp" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image:member" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "webp", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ViewRegistryViewByTypeMapping:type", "docComment": "/**\n * Internal mapping of view types to their typed view creator functions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ViewRegistryViewByTypeMapping = " }, { "kind": "Content", "text": "{\n [TViewType in " }, { "kind": "Reference", "text": "ViewTypeType", "canonicalReference": "obsidian-typings!ViewTypeType:type" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "TypedViewCreator", "canonicalReference": "obsidian-typings!TypedViewCreator:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ViewTypeViewMapping", "canonicalReference": "obsidian-typings!ViewTypeViewMapping:type" }, { "kind": "Content", "text": "[TViewType]>;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/view-registry/ViewRegistryViewByTypeMapping.d.ts", "releaseTag": "Public", "name": "ViewRegistryViewByTypeMapping", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ViewRegistryViewByTypeRecord:interface", "docComment": "/**\n * Record mapping view type strings to their corresponding view creator functions.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ViewRegistryViewByTypeRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "ViewCreator", "canonicalReference": "obsidian!ViewCreator:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ViewRegistryViewByTypeMapping", "canonicalReference": "obsidian-typings!ViewRegistryViewByTypeMapping:type" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/view-registry/ViewRegistryViewByTypeRecord.d.ts", "releaseTag": "Public", "name": "ViewRegistryViewByTypeRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Variable", "canonicalReference": "obsidian-typings!ViewType:var", "docComment": "/**\n * Constant mapping of view type identifiers used to open and manage different leaf views in Obsidian.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ViewType: " }, { "kind": "Content", "text": "{\n readonly AllProperties: \"all-properties\";\n readonly Audio: \"audio\";\n readonly Backlink: \"backlink\";\n readonly Bases: \"bases\";\n readonly Bookmarks: \"bookmarks\";\n readonly Canvas: \"canvas\";\n readonly Empty: \"empty\";\n readonly FileExplorer: \"file-explorer\";\n readonly FileProperties: \"file-properties\";\n readonly Graph: \"graph\";\n readonly Image: \"image\";\n readonly LocalGraph: \"localgraph\";\n readonly Markdown: \"markdown\";\n readonly OutgoingLink: \"outgoing-link\";\n readonly Outline: \"outline\";\n readonly Pdf: \"pdf\";\n readonly ReleaseNotes: \"release-notes\";\n readonly Search: \"search\";\n readonly Sync: \"sync\";\n readonly Table: \"table\";\n readonly Tag: \"tag\";\n readonly Video: \"video\";\n readonly Webviewer: \"webviewer\";\n readonly WebviewerHistory: \"webviewer-history\";\n}" } ], "fileUrlPath": "src/obsidian/implementations/constants/ViewType.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "ViewType", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ViewTypeType:type", "docComment": "/**\n * Union type of all built-in view type string identifiers.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ViewTypeType = " }, { "kind": "Content", "text": "(typeof " }, { "kind": "Reference", "text": "ViewType", "canonicalReference": "obsidian-typings!ViewType:var" }, { "kind": "Content", "text": ")[keyof typeof " }, { "kind": "Reference", "text": "ViewType", "canonicalReference": "obsidian-typings!ViewType:var" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/views/ViewTypeType.d.ts", "releaseTag": "Public", "name": "ViewTypeType", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "obsidian-typings!ViewTypeViewMapping:type", "docComment": "/**\n * Mapping from view type identifiers to their corresponding view instance types.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ViewTypeViewMapping = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "ViewType.AllProperties", "canonicalReference": "obsidian-typings!~__type#AllProperties" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "AllPropertiesView", "canonicalReference": "obsidian-typings!AllPropertiesView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Audio", "canonicalReference": "obsidian-typings!~__type#Audio" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "AudioView", "canonicalReference": "obsidian-typings!AudioView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Backlink", "canonicalReference": "obsidian-typings!~__type#Backlink" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BacklinkView", "canonicalReference": "obsidian-typings!BacklinkView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Bases", "canonicalReference": "obsidian-typings!~__type#Bases" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BasesView", "canonicalReference": "obsidian-typings!BasesView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Bookmarks", "canonicalReference": "obsidian-typings!~__type#Bookmarks" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "BookmarksView", "canonicalReference": "obsidian-typings!BookmarksView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Webviewer", "canonicalReference": "obsidian-typings!~__type#Webviewer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "WebviewerView", "canonicalReference": "obsidian-typings!WebviewerView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.WebviewerHistory", "canonicalReference": "obsidian-typings!~__type#WebviewerHistory" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "WebviewerHistoryView", "canonicalReference": "obsidian-typings!WebviewerHistoryView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Canvas", "canonicalReference": "obsidian-typings!~__type#Canvas" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "CanvasView", "canonicalReference": "obsidian-typings!CanvasView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Empty", "canonicalReference": "obsidian-typings!~__type#Empty" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "EmptyView", "canonicalReference": "obsidian-typings!EmptyView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.FileExplorer", "canonicalReference": "obsidian-typings!~__type#FileExplorer" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "FileExplorerView", "canonicalReference": "obsidian-typings!FileExplorerView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.FileProperties", "canonicalReference": "obsidian-typings!~__type#FileProperties" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "FilePropertiesView", "canonicalReference": "obsidian-typings!FilePropertiesView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Graph", "canonicalReference": "obsidian-typings!~__type#Graph" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "GraphView", "canonicalReference": "obsidian-typings!GraphView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Image", "canonicalReference": "obsidian-typings!~__type#Image" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "ImageView", "canonicalReference": "obsidian-typings!ImageView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.LocalGraph", "canonicalReference": "obsidian-typings!~__type#LocalGraph" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "LocalGraphView", "canonicalReference": "obsidian-typings!LocalGraphView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Markdown", "canonicalReference": "obsidian-typings!~__type#Markdown" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "MarkdownView", "canonicalReference": "obsidian!MarkdownView:class" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.OutgoingLink", "canonicalReference": "obsidian-typings!~__type#OutgoingLink" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "OutgoingLinkView", "canonicalReference": "obsidian-typings!OutgoingLinkView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Outline", "canonicalReference": "obsidian-typings!~__type#Outline" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "OutlineView", "canonicalReference": "obsidian-typings!OutlineView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Pdf", "canonicalReference": "obsidian-typings!~__type#Pdf" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "PdfView", "canonicalReference": "obsidian-typings!PdfView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.ReleaseNotes", "canonicalReference": "obsidian-typings!~__type#ReleaseNotes" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "ReleaseNotesView", "canonicalReference": "obsidian-typings!ReleaseNotesView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Search", "canonicalReference": "obsidian-typings!~__type#Search" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SearchView", "canonicalReference": "obsidian-typings!SearchView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Sync", "canonicalReference": "obsidian-typings!~__type#Sync" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "SyncView", "canonicalReference": "obsidian-typings!SyncView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Table", "canonicalReference": "obsidian-typings!~__type#Table" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "TableView", "canonicalReference": "obsidian-typings!TableView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Tag", "canonicalReference": "obsidian-typings!~__type#Tag" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "TagView", "canonicalReference": "obsidian-typings!TagView:interface" }, { "kind": "Content", "text": ";\n [" }, { "kind": "Reference", "text": "ViewType.Video", "canonicalReference": "obsidian-typings!~__type#Video" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "VideoView", "canonicalReference": "obsidian-typings!VideoView:interface" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/obsidian/internals/views/ViewTypeViewMapping.d.ts", "releaseTag": "Public", "name": "ViewTypeViewMapping", "typeTokenRange": { "startIndex": 1, "endIndex": 98 } }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VimApi:interface", "docComment": "/**\n * Public API for interacting with the Vim emulation layer.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VimApi " } ], "fileUrlPath": "src/@codemirror__view/internals/vim/VimApi.d.ts", "releaseTag": "Public", "name": "VimApi", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#_mapCommand:member(1)", "docComment": "/**\n * Register an internal key mapping command.\n *\n * @param command - The command to register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_mapCommand(command: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "_mapCommand" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#buildKeyMap:member(1)", "docComment": "/**\n * Build the key map from the current configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buildKeyMap(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "buildKeyMap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#defineAction:member(1)", "docComment": "/**\n * Define a new Vim action with the given name and handler function.\n *\n * @param name - The name of the action.\n *\n * @param fn - The handler function for the action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineAction(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", fn: " }, { "kind": "Content", "text": "(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", actionArgs: object, vim: " }, { "kind": "Reference", "text": "VimState", "canonicalReference": "obsidian-typings!VimState:interface" }, { "kind": "Content", "text": "['vim']) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "defineAction" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#defineEx:member(1)", "docComment": "/**\n * Define a new Ex command with the given name and prefix.\n *\n * @param name - The name of the Ex command.\n *\n * @param prefix - The prefix for the Ex command.\n *\n * @param func - The function to execute for the Ex command.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineEx(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", prefix: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", func: " }, { "kind": "Content", "text": "(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", params: object) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "prefix", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "func", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 }, "isOptional": false } ], "name": "defineEx" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#defineMotion:member(1)", "docComment": "/**\n * Define a new Vim motion with the given name and handler.\n *\n * @param name - The name of the motion.\n *\n * @param fn - The handler function for the motion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineMotion(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", fn: " }, { "kind": "Content", "text": "(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", head: object, motionArgs: object, vim: " }, { "kind": "Reference", "text": "VimState", "canonicalReference": "obsidian-typings!VimState:interface" }, { "kind": "Content", "text": "['vim']) => object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "isOptional": false } ], "name": "defineMotion" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#defineOperator:member(1)", "docComment": "/**\n * Define a new Vim operator with the given name and handler.\n *\n * @param name - The name of the operator.\n *\n * @param fn - The handler function for the operator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineOperator(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", fn: " }, { "kind": "Content", "text": "(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", operatorArgs: object, ranges: object[], oldAnchor: object, newHead: object) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "defineOperator" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#defineOption:member(1)", "docComment": "/**\n * Define a new Vim option with default value, type, aliases, and change callback.\n *\n * @param name - The name of the option.\n *\n * @param defaultValue - The default value for the option.\n *\n * @param type - The type of the option.\n *\n * @param aliases - The aliases for the option.\n *\n * @param callback - The callback invoked when the option changes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineOption(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", defaultValue: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", aliases?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", callback?: " }, { "kind": "Content", "text": "(value: unknown, cm?: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "defaultValue", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "aliases", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 12 }, "isOptional": true } ], "name": "defineOption" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#defineRegister:member(1)", "docComment": "/**\n * Define a new named register.\n *\n * @param name - The name of the register.\n *\n * @param register - The register object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defineRegister(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", register: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "register", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "defineRegister" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#enterInsertMode:member(1)", "docComment": "/**\n * Enter insert mode in the given editor.\n *\n * @param cm - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enterInsertMode(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "enterInsertMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#enterVimMode:member(1)", "docComment": "/**\n * Enter Vim mode in the given editor.\n *\n * @param cm - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enterVimMode(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "enterVimMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#exitInsertMode:member(1)", "docComment": "/**\n * Exit insert mode, optionally keeping the cursor position.\n *\n * @param cm - The editor instance.\n *\n * @param keepCursor - Whether to keep the cursor position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exitInsertMode(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", keepCursor?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "keepCursor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "exitInsertMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#exitVisualMode:member(1)", "docComment": "/**\n * Exit visual mode, optionally moving the head of the selection.\n *\n * @param cm - The editor instance.\n *\n * @param moveHead - Whether to move the head of the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exitVisualMode(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", moveHead?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "moveHead", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "exitVisualMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#findKey:member(1)", "docComment": "/**\n * Look up a key binding in the given editor and origin context.\n *\n * @param cm - The editor instance.\n *\n * @param key - The key to look up.\n *\n * @param origin - The origin context for the lookup.\n *\n * @returns Whether a binding was found and handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "findKey(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "findKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#getOption:member(1)", "docComment": "/**\n * Get the value of a Vim option.\n *\n * @param name - The name of the option.\n *\n * @param cm - The editor instance.\n *\n * @param cfg - The configuration object.\n *\n * @returns The option value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOption(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", cm?: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", cfg?: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "cfg", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "getOption" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#getRegisterController:member(1)", "docComment": "/**\n * Get the register controller managing all registers.\n *\n * @returns The register controller.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRegisterController(): " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getRegisterController" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#getVimGlobalState_:member(1)", "docComment": "/**\n * Get the global Vim state object.\n *\n * @returns The global Vim state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getVimGlobalState_(): " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getVimGlobalState_" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#handleEx:member(1)", "docComment": "/**\n * Handle an Ex command input string.\n *\n * @param cm - The editor instance.\n *\n * @param input - The Ex command input string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleEx(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", input: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "handleEx" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#handleKey:member(1)", "docComment": "/**\n * Handle a key press in the given editor with the specified origin.\n *\n * @param cm - The editor instance.\n *\n * @param key - The key that was pressed.\n *\n * @param origin - The origin of the key press.\n *\n * @returns Whether the key was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleKey(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "handleKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#InsertModeKey:member(1)", "docComment": "/**\n * Create an insert mode key binding for the given key name.\n *\n * @param keyName - The key name to bind.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "InsertModeKey(keyName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "keyName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "InsertModeKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#leaveVimMode:member(1)", "docComment": "/**\n * Leave Vim mode in the given editor.\n *\n * @param cm - The editor instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "leaveVimMode(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "leaveVimMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#map:member(1)", "docComment": "/**\n * Create a recursive key mapping from lhs to rhs in the given context.\n *\n * @param lhs - The left-hand side key sequence.\n *\n * @param rhs - The right-hand side key sequence or command.\n *\n * @param ctx - The mapping context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "map(lhs: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", rhs: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ctx?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lhs", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "rhs", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "ctx", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "map" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#mapclear:member(1)", "docComment": "/**\n * Clear all key mappings in the given context.\n *\n * @param ctx - The mapping context to clear.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mapclear(ctx?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "ctx", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "mapclear" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#mapCommand:member(1)", "docComment": "/**\n * Map a key sequence to a command type, name, args, and extra options.\n *\n * @param keys - The key sequence to map.\n *\n * @param type - The command type.\n *\n * @param name - The command name.\n *\n * @param args - The command arguments.\n *\n * @param extra - The extra options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "mapCommand(keys: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", args?: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ", extra?: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "keys", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "extra", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ], "name": "mapCommand" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#maybeInitVimState_:member(1)", "docComment": "/**\n * Initialize the Vim state for the given editor if not already initialized.\n *\n * @param cm - The editor instance.\n *\n * @returns The Vim state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maybeInitVimState_(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "VimState", "canonicalReference": "obsidian-typings!VimState:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "maybeInitVimState_" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#multiSelectHandleKey:member(1)", "docComment": "/**\n * Handle a key press in multi-select mode.\n *\n * @param cm - The editor instance.\n *\n * @param key - The key that was pressed.\n *\n * @param origin - The origin of the key press.\n *\n * @returns Whether the key was handled.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "multiSelectHandleKey(cm: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "multiSelectHandleKey" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#noremap:member(1)", "docComment": "/**\n * Create a non-recursive key mapping from lhs to rhs in the given context.\n *\n * @param lhs - The left-hand side key sequence.\n *\n * @param rhs - The right-hand side key sequence or command.\n *\n * @param ctx - The mapping context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "noremap(lhs: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", rhs: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ctx?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lhs", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "rhs", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "ctx", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "noremap" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#resetVimGlobalState_:member(1)", "docComment": "/**\n * Reset the global Vim state to defaults.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resetVimGlobalState_(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "resetVimGlobalState_" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#setOption:member(1)", "docComment": "/**\n * Set the value of a Vim option.\n *\n * @param name - The name of the option.\n *\n * @param value - The value to set.\n *\n * @param cm - The editor instance.\n *\n * @param cfg - The configuration object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setOption(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", cm?: " }, { "kind": "Reference", "text": "VimEditor", "canonicalReference": "obsidian-typings!VimEditor:interface" }, { "kind": "Content", "text": ", cfg?: " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "cm", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "cfg", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "setOption" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimApi#suppressErrorLogging:member", "docComment": "/**\n * Whether to suppress error logging from the Vim layer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suppressErrorLogging: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suppressErrorLogging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!VimApi#unmap:member(1)", "docComment": "/**\n * Remove a key mapping for lhs in the given context.\n *\n * @param lhs - The left-hand side key sequence to unmap.\n *\n * @param ctx - The mapping context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "unmap(lhs: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ctx?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "lhs", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "ctx", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "unmap" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VimEditor:interface", "docComment": "/**\n * Wrapper around an editor instance providing access to Vim state.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VimEditor " } ], "fileUrlPath": "src/@codemirror__view/internals/vim/VimEditor.d.ts", "releaseTag": "Public", "name": "VimEditor", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimEditor#state:member", "docComment": "/**\n * The Vim state associated with this editor.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Reference", "text": "VimState", "canonicalReference": "obsidian-typings!VimState:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VimState:interface", "docComment": "/**\n * Top-level Vim state container for the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VimState " } ], "fileUrlPath": "src/@codemirror__view/internals/vim/VimState.d.ts", "releaseTag": "Public", "name": "VimState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimState#vim:member", "docComment": "/**\n * Core Vim mode and command state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vim: " }, { "kind": "Reference", "text": "VimStateVim", "canonicalReference": "obsidian-typings!VimStateVim:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vim", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimState#vimPlugin:member", "docComment": "/**\n * Vim plugin state for tracking key events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "vimPlugin: " }, { "kind": "Reference", "text": "VimStateVimPlugin", "canonicalReference": "obsidian-typings!VimStateVimPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "vimPlugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VimStateVim:interface", "docComment": "/**\n * Core Vim state holding mode, input state, and edit history.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VimStateVim " } ], "fileUrlPath": "src/@codemirror__view/internals/vim/VimStateVim.d.ts", "releaseTag": "Public", "name": "VimStateVim", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#inputState:member", "docComment": "/**\n * Current input state of the Vim command parser.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inputState: " }, { "kind": "Reference", "text": "VimStateVimInputState", "canonicalReference": "obsidian-typings!VimStateVimInputState:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inputState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#insertMode:member", "docComment": "/**\n * Whether the editor is currently in insert mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertMode: " }, { "kind": "Content", "text": "false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "insertMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#insertModeRepeat:member", "docComment": "/**\n * Repeat count for the current insert mode session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "insertModeRepeat: " }, { "kind": "Content", "text": "undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "insertModeRepeat", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#lastEditActionCommand:member", "docComment": "/**\n * The last edit action command that was executed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastEditActionCommand: " }, { "kind": "Content", "text": "undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastEditActionCommand", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#lastEditInputState:member", "docComment": "/**\n * Input state snapshot of the last edit action.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastEditInputState: " }, { "kind": "Content", "text": "undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastEditInputState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#lastHPos:member", "docComment": "/**\n * Last horizontal cursor position (column).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastHPos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastHPos", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#lastHSPos:member", "docComment": "/**\n * Last horizontal cursor screen position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastHSPos: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastHSPos", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#lastMotion:member", "docComment": "/**\n * The last motion that was executed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastMotion: " }, { "kind": "Reference", "text": "VimStateVimLastMotion", "canonicalReference": "obsidian-typings!VimStateVimLastMotion:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastMotion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#lastPastedText:member", "docComment": "/**\n * The last text that was pasted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastPastedText: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastPastedText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVim#lastSelection:member", "docComment": "/**\n * The last visual selection range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastSelection: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastSelection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VimStateVimInputState:interface", "docComment": "/**\n * Tracks the current input state of the Vim command parser.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VimStateVimInputState " } ], "fileUrlPath": "src/@codemirror__view/internals/vim/VimStateVimInputState.d.ts", "releaseTag": "Public", "name": "VimStateVimInputState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#changeQueue:member", "docComment": "/**\n * Queue of pending changes to apply.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "changeQueue: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "changeQueue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#keyBuffer:member", "docComment": "/**\n * Buffer of keys pressed for the current command sequence.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "keyBuffer: " }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "keyBuffer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#motion:member", "docComment": "/**\n * Current pending motion command.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "motion: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "motion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#motionArgs:member", "docComment": "/**\n * Arguments for the current pending motion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "motionArgs: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "motionArgs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#motionRepeat:member", "docComment": "/**\n * Repeat count for the current motion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "motionRepeat: " }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "motionRepeat", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#operator:member", "docComment": "/**\n * Current pending operator command.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "operator: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "operator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#operatorArgs:member", "docComment": "/**\n * Arguments for the current pending operator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "operatorArgs: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "operatorArgs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#prefixRepeat:member", "docComment": "/**\n * Prefix repeat count for the current command.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prefixRepeat: " }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "prefixRepeat", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimInputState#registerName:member", "docComment": "/**\n * Name of the currently specified register.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "registerName: " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "registerName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VimStateVimLastMotion:interface", "docComment": "/**\n * Represents the last motion executed in Vim mode.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VimStateVimLastMotion " } ], "fileUrlPath": "src/@codemirror__view/internals/vim/VimStateVimLastMotion.d.ts", "releaseTag": "Public", "name": "VimStateVimLastMotion", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimLastMotion#name:member", "docComment": "/**\n * Name of the last executed motion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!VimStateVimPlugin:interface", "docComment": "/**\n * Vim plugin state tracking the last keydown event.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VimStateVimPlugin " } ], "fileUrlPath": "src/@codemirror__view/internals/vim/VimStateVimPlugin.d.ts", "releaseTag": "Public", "name": "VimStateVimPlugin", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!VimStateVimPlugin#lastKeydown:member", "docComment": "/**\n * The last keydown event key string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastKeydown: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastKeydown", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WatchAndStatAllResult:interface", "docComment": "/**\n * Result from watching and stating all files in a directory on Capacitor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WatchAndStatAllResult " } ], "fileUrlPath": "src/obsidian/internals/WatchAndStatAllResult.d.ts", "releaseTag": "Public", "name": "WatchAndStatAllResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WatchAndStatAllResult#children:member", "docComment": "/**\n * File entries found in the watched directory.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "children: " }, { "kind": "Reference", "text": "CapacitorFileEntry", "canonicalReference": "obsidian-typings!CapacitorFileEntry:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WeakMapWrapper:interface", "docComment": "/**\n * Wrapper around a WeakMap providing the same interface with an inner map reference.\n *\n * @typeParam K - The key type.\n *\n * @typeParam V - The value type.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WeakMapWrapper<K extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ", V> extends " }, { "kind": "Reference", "text": "WeakMap", "canonicalReference": "!WeakMap:interface" }, { "kind": "Content", "text": "<K, V>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/WeakMapWrapper.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "V", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "WeakMapWrapper", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WeakMapWrapper#map:member", "docComment": "/**\n * The underlying WeakMap instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "map: " }, { "kind": "Reference", "text": "WeakMap", "canonicalReference": "!WeakMap:interface" }, { "kind": "Content", "text": "<K, V>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "map", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WebPreferences:interface", "docComment": "/**\n * Web preferences for configuring Electron web content behavior.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WebPreferences " } ], "fileUrlPath": "src/electron/internals/WebPreferences.d.ts", "releaseTag": "Public", "name": "WebPreferences", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#accessibleTitle:member", "docComment": "/**\n * An alternative title string provided only to accessibility tools such as screen readers. This string is not directly visible to users.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accessibleTitle?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "accessibleTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#additionalArguments:member", "docComment": "/**\n * A list of strings that will be appended to `process.argv` in the renderer process of this app. Useful for passing small bits of data down to renderer process preload scripts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "additionalArguments?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "additionalArguments", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#allowRunningInsecureContent:member", "docComment": "/**\n * Allow an https page to run JavaScript, CSS or plugins from http URLs.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "allowRunningInsecureContent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "allowRunningInsecureContent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#autoplayPolicy:member", "docComment": "/**\n * Autoplay policy to apply to content in the window.\n *\n * @default\n *\n * `no-user-gesture-required`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoplayPolicy?: " }, { "kind": "Content", "text": "'document-user-activation-required' | 'no-user-gesture-required' | 'user-gesture-required'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "autoplayPolicy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#backgroundThrottling:member", "docComment": "/**\n * Whether to throttle animations and timers when the page becomes background. This also affects the Page Visibility API.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundThrottling?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "backgroundThrottling", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#contextIsolation:member", "docComment": "/**\n * Whether to run Electron APIs and the specified `preload` script in a separate JavaScript context.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contextIsolation?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "contextIsolation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#defaultEncoding:member", "docComment": "/**\n * The default text encoding.\n *\n * @default\n *\n * `ISO-8859-1`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultEncoding?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultEncoding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#defaultFontFamily:member", "docComment": "/**\n * Sets the default font for the font-family.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultFontFamily?: " }, { "kind": "Reference", "text": "ElectronDefaultFontFamily", "canonicalReference": "obsidian-typings!ElectronDefaultFontFamily:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultFontFamily", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#defaultFontSize:member", "docComment": "/**\n * The default font size in pixels.\n *\n * @default\n *\n * `16`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultFontSize?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultFontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#defaultMonospaceFontSize:member", "docComment": "/**\n * The default monospace font size in pixels.\n *\n * @default\n *\n * `13`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultMonospaceFontSize?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultMonospaceFontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#devTools:member", "docComment": "/**\n * Whether to enable DevTools. If it is set to `false`, `BrowserWindow.webContents.openDevTools()` cannot be used to open DevTools.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "devTools?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "devTools", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#disableBlinkFeatures:member", "docComment": "/**\n * A list of feature strings separated by `,` to disable. The full list of supported feature strings can be found in the RuntimeEnabledFeatures.json5 file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableBlinkFeatures?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableBlinkFeatures", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#disableDialogs:member", "docComment": "/**\n * Whether to disable dialogs completely. Overrides `safeDialogs`.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableDialogs?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableDialogs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#disableHtmlFullscreenWindowResize:member", "docComment": "/**\n * Whether to prevent the window from resizing when entering HTML Fullscreen.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableHtmlFullscreenWindowResize?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableHtmlFullscreenWindowResize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#enableBlinkFeatures:member", "docComment": "/**\n * A list of feature strings separated by `,` to enable. The full list of supported feature strings can be found in the RuntimeEnabledFeatures.json5 file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableBlinkFeatures?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enableBlinkFeatures", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#enablePreferredSizeMode:member", "docComment": "/**\n * Whether to enable preferred size mode. Enabling this causes the `preferred-size-changed` event to be emitted on the `WebContents` when the preferred size changes.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enablePreferredSizeMode?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enablePreferredSizeMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#enableWebSQL:member", "docComment": "/**\n * Whether to enable the WebSQL api.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableWebSQL?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "enableWebSQL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#experimentalFeatures:member", "docComment": "/**\n * Enables Chromium's experimental features.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "experimentalFeatures?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "experimentalFeatures", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#imageAnimationPolicy:member", "docComment": "/**\n * Specifies how to run image animations (e.g. GIFs).\n *\n * @default\n *\n * `animate`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "imageAnimationPolicy?: " }, { "kind": "Content", "text": "'animate' | 'animateOnce' | 'noAnimation'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "imageAnimationPolicy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#images:member", "docComment": "/**\n * Enables image support.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "images?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "images", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#javascript:member", "docComment": "/**\n * Enables JavaScript support.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "javascript?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "javascript", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#minimumFontSize:member", "docComment": "/**\n * The minimum font size in pixels.\n *\n * @default\n *\n * `0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minimumFontSize?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "minimumFontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#navigateOnDragDrop:member", "docComment": "/**\n * Whether dragging and dropping a file or link onto the page causes a navigation.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "navigateOnDragDrop?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "navigateOnDragDrop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#nodeIntegration:member", "docComment": "/**\n * Whether node integration is enabled.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeIntegration?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nodeIntegration", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#nodeIntegrationInSubFrames:member", "docComment": "/**\n * Experimental option for enabling Node.js support in sub-frames such as iframes and child windows. All preloads will load for every iframe; `process.isMainFrame` can be used to determine if in the main frame or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeIntegrationInSubFrames?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nodeIntegrationInSubFrames", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#nodeIntegrationInWorker:member", "docComment": "/**\n * Whether node integration is enabled in web workers.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nodeIntegrationInWorker?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "nodeIntegrationInWorker", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#offscreen:member", "docComment": "/**\n * Whether to enable offscreen rendering for the browser window.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offscreen?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "offscreen", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#partition:member", "docComment": "/**\n * Sets the session used by the page according to the session's partition string. If `partition` starts with `persist:`, the page will use a persistent session available to all pages in the app with the same `partition`. If there is no `persist:` prefix, the page will use an in-memory session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "partition?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "partition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#plugins:member", "docComment": "/**\n * Whether plugins should be enabled.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugins?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "plugins", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#preload:member", "docComment": "/**\n * Specifies a script that will be loaded before other scripts run in the page. The value should be the absolute file path to the script.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preload?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "preload", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#safeDialogs:member", "docComment": "/**\n * Whether to enable browser style consecutive dialog protection.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "safeDialogs?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "safeDialogs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#safeDialogsMessage:member", "docComment": "/**\n * The message to display when consecutive dialog protection is triggered. If not defined the default message would be used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "safeDialogsMessage?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "safeDialogsMessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#sandbox:member", "docComment": "/**\n * If set, this will sandbox the renderer associated with the window, making it compatible with the Chromium OS-level sandbox and disabling the Node.js engine.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sandbox?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sandbox", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#scrollBounce:member", "docComment": "/**\n * Enables scroll bounce (rubber banding) effect on macOS.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollBounce?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scrollBounce", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#session:member", "docComment": "/**\n * Sets the session used by the page. When both `session` and `partition` are provided, `session` will be preferred.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "session?: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "obsidian-typings!Session:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#spellcheck:member", "docComment": "/**\n * Whether to enable the builtin spellchecker.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "spellcheck?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "spellcheck", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#textAreasAreResizable:member", "docComment": "/**\n * Make TextArea elements resizable.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "textAreasAreResizable?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "textAreasAreResizable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#v8CacheOptions:member", "docComment": "/**\n * Enforces the v8 code caching policy used by blink.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "v8CacheOptions?: " }, { "kind": "Content", "text": "'bypassHeatCheck' | 'bypassHeatCheckAndEagerCompile' | 'code' | 'none'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "v8CacheOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#webgl:member", "docComment": "/**\n * Enables WebGL support.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webgl?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webgl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#webSecurity:member", "docComment": "/**\n * When `false`, it will disable the same-origin policy, and set `allowRunningInsecureContent` to `true` if this option has not been set by the user.\n *\n * @default\n *\n * `true`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webSecurity?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webSecurity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#webviewTag:member", "docComment": "/**\n * Whether to enable the `<webview>` tag.\n *\n * @default\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "webviewTag?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "webviewTag", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebPreferences#zoomFactor:member", "docComment": "/**\n * The default zoom factor of the page, `3.0` represents `300%`.\n *\n * @default\n *\n * `1.0`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomFactor?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "zoomFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WebviewerDBStore:interface", "docComment": "/**\n * Stores and manages all history items and cached fav icons.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WebviewerDBStore " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/webviewer/WebviewerDBStore.d.ts", "releaseTag": "Public", "name": "WebviewerDBStore", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#addHistoryItem:member(1)", "docComment": "/**\n * Add a history item to the database.\n *\n * @param url - The URL of the history item.\n *\n * @param title - Optional title for the history item.\n *\n * @returns A promise that resolves when the history item is added.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "addHistoryItem(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "addHistoryItem" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#app:member", "docComment": "/**\n * Reference to the {@link obsidian#App}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#clearHistoryItems:member(1)", "docComment": "/**\n * Clear all history items.\n *\n * @returns A promise that resolves when all history items are cleared.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearHistoryItems(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearHistoryItems" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#connect:member(1)", "docComment": "/**\n * Open and initialize the IndexedDB connection.\n *\n * @returns A promise that resolves when the connection is established.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "connect(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "connect" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#db:member", "docComment": "/**\n * Underlying database used to store history items and fav icons via IndexedDB.\n *\n * @remark\n *\n * Use methods such as {@link WebviewerDBStore.addHistoryItem} etc. to interact with the stored history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "db: " }, { "kind": "Reference", "text": "IDBDatabase", "canonicalReference": "!IDBDatabase:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "db", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#getHistoryItems:member(1)", "docComment": "/**\n * Get all history items.\n *\n * @returns All stored history items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHistoryItems(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WebviewerHistoryItem", "canonicalReference": "obsidian-typings!WebviewerHistoryItem:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getHistoryItems" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#loadIcon:member(1)", "docComment": "/**\n * Load stored icon in Base64 encoded string. If no stored icon available in the database, it also stores the icon.\n *\n * @param domain - Domain name only, e.g. \"obsidian.md\".\n *\n * @param source - Source url of the icon, e.g. \"https://obsidian.md/favicon.ico\". Used as a fallback source if there is no icon stored with corresponding domain.\n *\n * @returns Icon in Base64 encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadIcon(domain: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", source?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "domain", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadIcon" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#removeHistoryItem:member(1)", "docComment": "/**\n * Remove specific history item based on its {@link WebviewerHistoryItem.id | id}.\n *\n * @param item - The history item to remove.\n *\n * @returns A promise that resolves when the history item is removed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "removeHistoryItem(item: " }, { "kind": "Reference", "text": "WebviewerHistoryItem", "canonicalReference": "obsidian-typings!WebviewerHistoryItem:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "item", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "removeHistoryItem" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#setIcon:member(1)", "docComment": "/**\n * Add a fav icon to the element.\n *\n * @param el - The element to add the icon to.\n *\n * @param url - The URL to get the icon for.\n *\n * @param source - Optional source URL for the icon.\n *\n * @returns A promise that resolves when the icon is set on the element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIcon(el: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", source?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "el", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "setIcon" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerDBStore#storeIcon:member(1)", "docComment": "/**\n * Store specific icon for the given domain name in Base64 string.\n *\n * @param domain - Domain name only, e.g. \"obsidian.md\".\n *\n * @param source - Source url of the icon, e.g. \"https://obsidian.md/favicon.ico\".\n *\n * @returns Icon in Base64 encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storeIcon(domain: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", source?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<null | string>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "domain", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "storeIcon" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WebviewerHistoryItem:interface", "docComment": "/**\n * Description of Webviewer history item.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WebviewerHistoryItem " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/webviewer/WebviewerHistoryItem.d.ts", "releaseTag": "Public", "name": "WebviewerHistoryItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerHistoryItem#accessTs:member", "docComment": "/**\n * Timestamp when the URL was visited.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accessTs: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "accessTs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerHistoryItem#id:member", "docComment": "/**\n * Unique ID of history item.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerHistoryItem#title:member", "docComment": "/**\n * Title of the URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerHistoryItem#url:member", "docComment": "/**\n * Destination URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WebviewerHistoryView:interface", "docComment": "/**\n * {@link obsidian#View} that displays the web browser browsing history.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WebviewerHistoryView extends " }, { "kind": "Reference", "text": "ItemView", "canonicalReference": "obsidian!ItemView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/webviewer/WebviewerHistoryView.d.ts", "releaseTag": "Public", "name": "WebviewerHistoryView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerHistoryView#constructor3__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param leaf - The workspace leaf.\n *\n * @param browserPluginInstance - The webviewer plugin instance.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor3__?(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", browserPluginInstance: " }, { "kind": "Reference", "text": "WebviewerPluginInstance", "canonicalReference": "obsidian-typings!WebviewerPluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "browserPluginInstance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor3__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerHistoryView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The webviewer history view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.WebviewerHistory", "canonicalReference": "obsidian-typings!~__type#WebviewerHistory:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerHistoryView#update:member(1)", "docComment": "/**\n * Refresh the browsing history list.\n *\n * @returns The result of refreshing the history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "update(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "update" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WebviewerOpenUrlEventDetail:interface", "docComment": "/**\n * Webviewer open URL event detail.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WebviewerOpenUrlEventDetail " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/webviewer/WebviewerOpenUrlEventDetail.d.ts", "releaseTag": "Public", "name": "WebviewerOpenUrlEventDetail", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerOpenUrlEventDetail#active:member", "docComment": "/**\n * Whether the URL is active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "active?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "active", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerOpenUrlEventDetail#newLeaf:member", "docComment": "/**\n * The new leaf.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newLeaf?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "PaneType", "canonicalReference": "obsidian!PaneType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "newLeaf", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerOpenUrlEventDetail#url:member", "docComment": "/**\n * The URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WebviewerPlugin:interface", "docComment": "/**\n * Internal plugin registration for the embedded web browser feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WebviewerPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WebviewerPluginInstance", "canonicalReference": "obsidian-typings!WebviewerPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/webviewer/WebviewerPlugin.d.ts", "releaseTag": "Public", "name": "WebviewerPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WebviewerPluginInstance:interface", "docComment": "/**\n * Plugin instance for the web viewer, providing an embedded web browser within Obsidian.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WebviewerPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WebviewerPlugin", "canonicalReference": "obsidian-typings!WebviewerPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/webviewer/WebviewerPluginInstance.d.ts", "releaseTag": "Public", "name": "WebviewerPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerPluginInstance#db:member", "docComment": "/**\n * Stored history items and cached fav icons.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "db: " }, { "kind": "Reference", "text": "WebviewerDBStore", "canonicalReference": "obsidian-typings!WebviewerDBStore:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "db", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "false" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerPluginInstance#getSearchEngineUrl:member(1)", "docComment": "/**\n * Build a search engine URL for the given search query.\n *\n * @param searchQuery - The search query to build a URL for.\n *\n * @returns The search engine URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSearchEngineUrl(searchQuery: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "searchQuery", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getSearchEngineUrl" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerPluginInstance#handleOpenUrl:member(1)", "docComment": "/**\n * Handle a custom open URL event from the webview.\n *\n * @param event - The custom event containing the URL details.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "handleOpenUrl(event: " }, { "kind": "Reference", "text": "CustomEvent", "canonicalReference": "!CustomEvent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WebviewerOpenUrlEventDetail", "canonicalReference": "obsidian-typings!WebviewerOpenUrlEventDetail:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "name": "handleOpenUrl" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerPluginInstance#openUrl:member(1)", "docComment": "/**\n * Open a URL in the web viewer.\n *\n * @param url - The URL to open.\n *\n * @param newLeaf - The pane type or whether to open in a new leaf.\n *\n * @param active - Whether to make the new leaf active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openUrl(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", newLeaf?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "PaneType", "canonicalReference": "obsidian!PaneType:type" }, { "kind": "Content", "text": ", active?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "newLeaf", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": true }, { "parameterName": "active", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "name": "openUrl" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerPluginInstance#openUrlExternally:member(1)", "docComment": "/**\n * Open a URL in the system default browser.\n *\n * @param url - The URL to open externally.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "openUrlExternally(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "openUrlExternally" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WebviewerPluginInstance#pendingIgnoredURLs:member", "docComment": "/**\n * URLs that are pending to be added to the ignore list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pendingIgnoredURLs: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "pendingIgnoredURLs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerPluginInstance#updateSession:member(1)", "docComment": "/**\n * Update the current browsing session state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateSession(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "updateSession" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WebviewerView:interface", "docComment": "/**\n * {@link obsidian#View} that renders an embedded web browser for browsing web pages within Obsidian.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WebviewerView extends " }, { "kind": "Reference", "text": "ItemView", "canonicalReference": "obsidian!ItemView:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/webviewer/WebviewerView.d.ts", "releaseTag": "Public", "name": "WebviewerView", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#closeSearch:member(1)", "docComment": "/**\n * Close the in-page search bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closeSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "closeSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#commitPageLoad:member(1)", "docComment": "/**\n * Finalize and commit the current page load.\n *\n * @returns The commit result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commitPageLoad(): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "commitPageLoad" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#configureWebContents:member(1)", "docComment": "/**\n * Configure the web contents settings for the webview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "configureWebContents(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "configureWebContents" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#constructor3__:member(1)", "docComment": "/**\n * Constructor.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param leaf - The workspace leaf.\n *\n * @param browserPluginInstance - The webviewer plugin instance.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor3__?(leaf: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ", browserPluginInstance: " }, { "kind": "Reference", "text": "WebviewerPluginInstance", "canonicalReference": "obsidian-typings!WebviewerPluginInstance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "leaf", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "browserPluginInstance", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "constructor3__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#contextMenuItemsForImg:member(1)", "docComment": "/**\n * Build context menu items for an image element.\n *\n * @param e - The image element context.\n *\n * @returns The context menu items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contextMenuItemsForImg(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "contextMenuItemsForImg" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#contextMenuItemsForLink:member(1)", "docComment": "/**\n * Build context menu items for a link element.\n *\n * @param e - The link element context.\n *\n * @param t - The link target information.\n *\n * @returns The context menu items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contextMenuItemsForLink(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "contextMenuItemsForLink" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#contextMenuItemsForSelection:member(1)", "docComment": "/**\n * Build context menu items for selected text.\n *\n * @param e - The selection context.\n *\n * @param t - The selection target information.\n *\n * @returns The context menu items.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contextMenuItemsForSelection(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "contextMenuItemsForSelection" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#displayBlank:member(1)", "docComment": "/**\n * Display a blank page in the webview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayBlank(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "displayBlank" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#displayContextMenu:member(1)", "docComment": "/**\n * Display a context menu at the given position.\n *\n * @param e - The context menu event data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayContextMenu(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "displayContextMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#displayErrorView:member(1)", "docComment": "/**\n * Shows the error view.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayErrorView(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "displayErrorView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#displayReaderView:member(1)", "docComment": "/**\n * Display the page content in reader mode.\n *\n * @returns Resolves when the reader view is displayed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayReaderView(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "displayReaderView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#displayWebView:member(1)", "docComment": "/**\n * Shows the webview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "displayWebView(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "displayWebView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#getReaderModeContent:member(1)", "docComment": "/**\n * Get the parsed content for reader mode.\n *\n * @returns The parsed reader mode content.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getReaderModeContent(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getReaderModeContent" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#getViewType:member(1)", "docComment": "/**\n * Get the current view type.\n *\n * @returns The webviewer view type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getViewType(): " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "ViewType.Webviewer", "canonicalReference": "obsidian-typings!~__type#Webviewer:member" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getViewType" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#hideAll:member(1)", "docComment": "/**\n * Hide all view content (webview, reader, error).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hideAll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hideAll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#instantiateWebView:member(1)", "docComment": "/**\n * Setup the webview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "instantiateWebView(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "instantiateWebView" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#navigate:member(1)", "docComment": "/**\n * Navigate the webview to a URL.\n *\n * @param e - The URL or navigation target.\n *\n * @param t - Navigation options.\n *\n * @returns The navigation result.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "navigate(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "navigate" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onCheckboxClick:member(1)", "docComment": "/**\n * Handle a checkbox click in reader mode.\n *\n * @param e - The click event.\n *\n * @param t - The checkbox element.\n *\n * @param n - The checkbox state information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onCheckboxClick(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onCheckboxClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onExternalLinkClick:member(1)", "docComment": "/**\n * Handle a click on an external link.\n *\n * @param e - The click event.\n *\n * @param t - The link element.\n *\n * @param n - The link target information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalLinkClick(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onExternalLinkClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onExternalLinkRightClick:member(1)", "docComment": "/**\n * Handle a right-click on an external link.\n *\n * @param e - The right-click event.\n *\n * @param t - The link element.\n *\n * @param n - The link target information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onExternalLinkRightClick(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onExternalLinkRightClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onFoldChange:member(1)", "docComment": "/**\n * Handle a fold/collapse state change in reader mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFoldChange(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onFoldChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onInternalLinkClick:member(1)", "docComment": "/**\n * Handle a click on an internal (vault) link.\n *\n * @param e - The click event.\n *\n * @param t - The link element.\n *\n * @param n - The link target information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInternalLinkClick(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onInternalLinkClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onInternalLinkDrag:member(1)", "docComment": "/**\n * Handle dragging an internal link.\n *\n * @param e - The drag event.\n *\n * @param t - The link element.\n *\n * @param n - The link target information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInternalLinkDrag(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onInternalLinkDrag" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onInternalLinkMouseover:member(1)", "docComment": "/**\n * Handle mouseover on an internal link for preview.\n *\n * @param e - The mouseover event.\n *\n * @param t - The link element.\n *\n * @param n - The link target information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInternalLinkMouseover(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onInternalLinkMouseover" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onInternalLinkRightClick:member(1)", "docComment": "/**\n * Handle a right-click on an internal link.\n *\n * @param e - The right-click event.\n *\n * @param t - The link element.\n *\n * @param n - The link target information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onInternalLinkRightClick(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onInternalLinkRightClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onReaderModeContextMenu:member(1)", "docComment": "/**\n * Handle a context menu event in reader mode.\n *\n * @param e - The context menu event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onReaderModeContextMenu(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onReaderModeContextMenu" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onRenderComplete:member(1)", "docComment": "/**\n * Called when the reader mode rendering is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onRenderComplete(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onRenderComplete" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onScroll:member(1)", "docComment": "/**\n * Handle scroll events in the webview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onScroll(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onScroll" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#onTagClick:member(1)", "docComment": "/**\n * Handle a click on a tag in reader mode.\n *\n * @param e - The click event.\n *\n * @param t - The tag element.\n *\n * @param n - The tag information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTagClick(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onTagClick" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#postProcess:member(1)", "docComment": "/**\n * Post-process rendered content in reader mode.\n *\n * @param e - The rendered content element.\n *\n * @param t - The processing context.\n *\n * @param n - Additional processing options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "postProcess(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", t: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ", n: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "t", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "postProcess" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#pushViewStackHistory:member(1)", "docComment": "/**\n * Push the current page to the view navigation history stack.\n *\n * @param e - The history entry to push.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pushViewStackHistory(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "pushViewStackHistory" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#reportPageLoad:member(1)", "docComment": "/**\n * Report a page load event to the history database.\n *\n * @param url - The URL of the loaded page.\n *\n * @param title - The title of the loaded page.\n *\n * @param navigate - Navigation metadata.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "reportPageLoad(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", navigate: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "navigate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "reportPageLoad" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#saveAsMarkdown:member(1)", "docComment": "/**\n * Save the current page content as a Markdown file.\n *\n * @returns Resolves when the file has been saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveAsMarkdown(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "saveAsMarkdown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#selectFavicon:member(1)", "docComment": "/**\n * Select the appropriate favicon for the current page.\n *\n * @param e - The favicon candidates.\n *\n * @returns The selected favicon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectFavicon(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "selectFavicon" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#setFavicon:member(1)", "docComment": "/**\n * Set the favicon for the current page.\n *\n * @param e - The favicon data.\n *\n * @returns The result of setting the favicon.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setFavicon(e: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "setFavicon" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#showSearch:member(1)", "docComment": "/**\n * Show the in-page search bar.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showSearch(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "showSearch" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#storeCurrentPageTitle:member(1)", "docComment": "/**\n * Stores the title of the current webview.\n *\n * @returns Resolves when the title has been stored.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storeCurrentPageTitle(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "storeCurrentPageTitle" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#toggleReaderMode:member(1)", "docComment": "/**\n * Toggles the reader mode.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toggleReaderMode(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "toggleReaderMode" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#zoomIn:member(1)", "docComment": "/**\n * Zoom in the webview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomIn(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "zoomIn" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#zoomOut:member(1)", "docComment": "/**\n * Zoom out the webview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomOut(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "zoomOut" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WebviewerView#zoomReset:member(1)", "docComment": "/**\n * Resets the zoom factor of the webview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zoomReset(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "zoomReset" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WidgetDecorationSpec:interface", "docComment": "/**\n * Specification for a widget decoration that inserts a widget at a position.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WidgetDecorationSpec " } ], "fileUrlPath": "src/@codemirror__view/internals/WidgetDecorationSpec.d.ts", "releaseTag": "Public", "name": "WidgetDecorationSpec", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetDecorationSpec#block:member", "docComment": "/**\n * Whether this is a block widget.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "block?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "block", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetDecorationSpec#side:member", "docComment": "/**\n * Which side of the position the widget is on.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "side?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "side", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetDecorationSpec#widget:member", "docComment": "/**\n * The widget to display.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "widget: " }, { "kind": "Reference", "text": "WidgetType", "canonicalReference": "@codemirror/view!WidgetType:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "widget", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WidgetEditorView:interface", "docComment": "/**\n * Editable widget view for embedded file sections (headings, blocks) within the editor.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WidgetEditorView extends " }, { "kind": "Reference", "text": "EmbeddedEditorView", "canonicalReference": "obsidian-typings!EmbeddedEditorView:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/WidgetEditorView.d.ts", "releaseTag": "Public", "name": "WidgetEditorView", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#after:member", "docComment": "/**\n * Data after reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "after: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "after", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#applyScope:member(1)", "docComment": "/**\n * Push/pop current scope.\n *\n * @param scope - {@link obsidian#Scope} to apply.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applyScope(scope: " }, { "kind": "Reference", "text": "Scope", "canonicalReference": "obsidian!Scope:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "scope", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "applyScope" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#before:member", "docComment": "/**\n * Data before reference.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "before: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "before", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#data:member", "docComment": "/**\n * Full file contents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#fileBeingRenamed:member", "docComment": "/**\n * File being currently renamed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fileBeingRenamed: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fileBeingRenamed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#getFoldInfo:member(1)", "docComment": "/**\n * Get the current folds of the editor.\n *\n * @returns Current fold information, or `null`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFoldInfo(): " }, { "kind": "Reference", "text": "FoldInfo", "canonicalReference": "obsidian-typings!FoldInfo:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getFoldInfo" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#heading:member", "docComment": "/**\n * Current heading.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "heading: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "heading", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#indent:member", "docComment": "/**\n * Indent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "indent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "indent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#inlineTitleEl:member", "docComment": "/**\n * Inline title element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "inlineTitleEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "inlineTitleEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#lastSavedData:member", "docComment": "/**\n * Full inline content string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lastSavedData: " }, { "kind": "Content", "text": "null | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lastSavedData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#loadContents:member(1)", "docComment": "/**\n * Splice incoming data at according to subpath for correct reference, then update heading and render.\n *\n * @param data - File contents.\n *\n * @param cache - Cached metadata for the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadContents(data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", cache: " }, { "kind": "Reference", "text": "CachedMetadata", "canonicalReference": "obsidian!CachedMetadata:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "cache", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "loadContents" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#loadFile:member(1)", "docComment": "/**\n * Load file from cache based on stored path.\n *\n * @returns A promise that resolves when the file has been loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadFile(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "loadFile" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#loadFileInternal:member(1)", "docComment": "/**\n * Load file and check if data is different from last saved data, then loads contents.\n *\n * @param data - File contents.\n *\n * @param cache - Cached metadata for the file.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "loadFileInternal(data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", cache?: " }, { "kind": "Reference", "text": "CachedMetadata", "canonicalReference": "obsidian!CachedMetadata:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "cache", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "loadFileInternal" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#onFileChanged:member(1)", "docComment": "/**\n * Update representation on file finished updating.\n *\n * @param file - The changed file.\n *\n * @param data - New file contents.\n *\n * @param cache - Updated cached metadata.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileChanged(file: " }, { "kind": "Reference", "text": "TFile", "canonicalReference": "obsidian!TFile:class" }, { "kind": "Content", "text": ", data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", cache: " }, { "kind": "Reference", "text": "CachedMetadata", "canonicalReference": "obsidian!CachedMetadata:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "cache", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "onFileChanged" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#onFileRename:member(1)", "docComment": "/**\n * Update representation on file rename.\n *\n * @param file - The renamed file.\n *\n * @param oldPath - Previous file path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onFileRename(file: " }, { "kind": "Reference", "text": "TAbstractFile", "canonicalReference": "obsidian!TAbstractFile:class" }, { "kind": "Content", "text": ", oldPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "file", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "oldPath", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onFileRename" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#onload:member(1)", "docComment": "/**\n * On loading widget, register vault change and rename events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#onMarkdownFold:member(1)", "docComment": "/**\n * Save fold made in the editor to foldManager.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onMarkdownFold(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onMarkdownFold" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#onTitleChange:member(1)", "docComment": "/**\n * On change of editor title element.\n *\n * @param element - The title element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTitleChange(element: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onTitleChange" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#onTitleKeydown:member(1)", "docComment": "/**\n * On keypress on editor title element.\n *\n * @param event - The keyboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTitleKeydown(event: " }, { "kind": "Reference", "text": "KeyboardEvent", "canonicalReference": "!KeyboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onTitleKeydown" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#onTitlePaste:member(1)", "docComment": "/**\n * On pasting on editor title element.\n *\n * @param element - The title element.\n *\n * @param event - The clipboard event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onTitlePaste(element: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ", event: " }, { "kind": "Reference", "text": "ClipboardEvent", "canonicalReference": "!ClipboardEvent:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "onTitlePaste" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#onunload:member(1)", "docComment": "/**\n * On unloading widget, unload component and remove scope.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onunload(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "onunload" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#save:member(1)", "docComment": "/**\n * Save changes made in editable widget.\n *\n * @param data - Data to save.\n *\n * @param delayed - Whether to delay the save.\n *\n * @returns A promise that resolves when the data has been saved.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "save(data: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", delayed?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "delayed", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "save" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#saveAgain:member", "docComment": "/**\n * Whether embedding should be saved twice on save.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveAgain: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "saveAgain", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#saveTitle:member(1)", "docComment": "/**\n * On blur widget, save title.\n *\n * @param element - The title element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saveTitle(element: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "element", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "saveTitle" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#saving:member", "docComment": "/**\n * Whether the widget is currently saving.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "saving: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "saving", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WidgetEditorView#showPreview:member(1)", "docComment": "/**\n * Show preview of widget.\n *\n * @param show - Whether to show or hide the preview.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showPreview(show?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "show", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "showPreview" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#subpath:member", "docComment": "/**\n * Subpath reference of the path.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subpath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subpath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WidgetEditorView#subpathNotFound:member", "docComment": "/**\n * Whether the subpath was not found in the cache.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "subpathNotFound: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "subpathNotFound", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WindowSelection:interface", "docComment": "/**\n * Represents a captured text selection within a window.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WindowSelection " } ], "fileUrlPath": "src/obsidian/internals/WindowSelection.d.ts", "releaseTag": "Public", "name": "WindowSelection", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WindowSelection#focusEl:member", "docComment": "/**\n * Element that has focus within the selection.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusEl: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusEl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WindowSelection#range:member", "docComment": "/**\n * The selected DOM range.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "range: " }, { "kind": "Reference", "text": "globalThis.Range", "canonicalReference": "!Range:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "range", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WindowSelection#win:member", "docComment": "/**\n * Window in which the selection exists.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "win: " }, { "kind": "Reference", "text": "Window", "canonicalReference": "!Window:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "win", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WordCountPlugin:interface", "docComment": "/**\n * Internal plugin registration for the word/character count status bar feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WordCountPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WordCountPluginInstance", "canonicalReference": "obsidian-typings!WordCountPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/word-count/WordCountPlugin.d.ts", "releaseTag": "Public", "name": "WordCountPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WordCountPluginInstance:interface", "docComment": "/**\n * Plugin instance for word count, displaying word and character counts in the status bar.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WordCountPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WordCountPlugin", "canonicalReference": "obsidian-typings!WordCountPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/word-count/WordCountPluginInstance.d.ts", "releaseTag": "Public", "name": "WordCountPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WordCountPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WordCountPluginInstance#defaultOn:member", "docComment": "/**\n * Whether this plugin is enabled by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOn: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultOn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WordCountPluginInstance#plugin:member", "docComment": "/**\n * Reference to the word count plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "WordCountPlugin", "canonicalReference": "obsidian-typings!WordCountPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WorkerResults:interface", "docComment": "/**\n * Worker results.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WorkerResults " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/graph/WorkerResults.d.ts", "releaseTag": "Public", "name": "WorkerResults", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkerResults#buffer:member", "docComment": "/**\n * Shared buffer containing node position data from the simulation worker.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buffer: " }, { "kind": "Reference", "text": "SharedArrayBuffer", "canonicalReference": "!SharedArrayBuffer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "buffer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkerResults#id:member", "docComment": "/**\n * Array of node identifiers corresponding to entries in the buffer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkerResults#v:member", "docComment": "/**\n * Version counter for tracking simulation updates.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "v?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "v", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WorkspaceHoverLinkSourcesRecord:interface", "docComment": "/**\n * Record mapping source identifiers to their hover link source configurations.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WorkspaceHoverLinkSourcesRecord extends " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, " }, { "kind": "Reference", "text": "HoverLinkSource", "canonicalReference": "obsidian!HoverLinkSource:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/workspace/WorkspaceHoverLinkSourcesRecord.d.ts", "releaseTag": "Public", "name": "WorkspaceHoverLinkSourcesRecord", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory:interface", "docComment": "/**\n * Navigation history for a workspace leaf, supporting back/forward navigation.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WorkspaceLeafHistory " } ], "fileUrlPath": "src/obsidian/internals/workspace-leaf-history/WorkspaceLeafHistory.d.ts", "releaseTag": "Public", "name": "WorkspaceLeafHistory", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#back:member(1)", "docComment": "/**\n * Navigate back to the previous state.\n *\n * @returns A promise that resolves when navigation is complete. To get the constructor instance, use {@link getWorkspaceLeafHistoryConstructor} from `obsidian-typings/implementations`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "back(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "back" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#backHistory:member", "docComment": "/**\n * List of previous navigation states.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backHistory: " }, { "kind": "Reference", "text": "WorkspaceLeafHistoryState", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "backHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#constructor__:member(1)", "docComment": "/**\n * Constructor.\n *\n * To get the constructor instance, use {@link getWorkspaceLeafHistoryConstructor} from `obsidian-typings/implementations`.\n *\n * @deprecated\n *\n * - Added only for typing purposes.\n *\n * @param owner - The owner.\n *\n * @returns The new instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor__?(owner: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "owner", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructor__" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#deserialize:member(1)", "docComment": "/**\n * Restore history from a serialized representation.\n *\n * @param e - The serialized history data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deserialize(e: " }, { "kind": "Reference", "text": "SerializedWorkspaceLeafHistory", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeafHistory:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "deserialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#forward:member(1)", "docComment": "/**\n * Navigate forward to the next state.\n *\n * @returns A promise that resolves when navigation is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forward(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "forward" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#forwardHistory:member", "docComment": "/**\n * List of forward navigation states (after going back).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "forwardHistory: " }, { "kind": "Reference", "text": "WorkspaceLeafHistoryState", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "forwardHistory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#go:member(1)", "docComment": "/**\n * Navigate by the given number of steps (negative for back, positive for forward).\n *\n * @param step - The number of steps to navigate.\n *\n * @returns A promise that resolves when navigation is complete.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "go(step: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "step", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "go" }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#owner:member", "docComment": "/**\n * The workspace leaf that owns this history.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "owner: " }, { "kind": "Reference", "text": "WorkspaceLeaf", "canonicalReference": "obsidian!WorkspaceLeaf:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "owner", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#pushState:member(1)", "docComment": "/**\n * Push a new state onto the back history stack.\n *\n * @param state - The history state to push.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pushState(state: " }, { "kind": "Reference", "text": "WorkspaceLeafHistoryState", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "pushState" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#serialize:member(1)", "docComment": "/**\n * Serialize the history for persistence.\n *\n * @returns The serialized history data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serialize(): " }, { "kind": "Reference", "text": "SerializedWorkspaceLeafHistory", "canonicalReference": "obsidian-typings!SerializedWorkspaceLeafHistory:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "serialize" }, { "kind": "MethodSignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistory#updateState:member(1)", "docComment": "/**\n * Update the current state in the history.\n *\n * @param state - The history state to update with.\n *\n * @returns A promise that resolves when the state is updated.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateState(state: " }, { "kind": "Reference", "text": "WorkspaceLeafHistoryState", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "updateState" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState:interface", "docComment": "/**\n * A single state entry in a workspace leaf's navigation history.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WorkspaceLeafHistoryState " } ], "fileUrlPath": "src/obsidian/internals/workspace-leaf-history/WorkspaceLeafHistoryState.d.ts", "releaseTag": "Public", "name": "WorkspaceLeafHistoryState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState#eState:member", "docComment": "/**\n * Ephemeral editor state (cursor position, scroll, etc.).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "eState: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "eState", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState#icon:member", "docComment": "/**\n * Icon associated with this history entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "icon: " }, { "kind": "Reference", "text": "IconName", "canonicalReference": "obsidian!IconName:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState#state:member", "docComment": "/**\n * View state data for this history entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspaceLeafHistoryState#title:member", "docComment": "/**\n * Display title for this history entry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WorkspacesPlugin:interface", "docComment": "/**\n * Internal plugin registration for the workspaces (layout saving/loading) feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WorkspacesPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspacesPluginInstance", "canonicalReference": "obsidian-typings!WorkspacesPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/workspaces/WorkspacesPlugin.d.ts", "releaseTag": "Public", "name": "WorkspacesPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!WorkspacesPluginInstance:interface", "docComment": "/**\n * Plugin instance for workspaces, managing saving and loading of workspace layouts.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WorkspacesPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WorkspacesPlugin", "canonicalReference": "obsidian-typings!WorkspacesPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/workspaces/WorkspacesPluginInstance.d.ts", "releaseTag": "Public", "name": "WorkspacesPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspacesPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!WorkspacesPluginInstance#plugin:member", "docComment": "/**\n * Reference to the workspaces plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "WorkspacesPlugin", "canonicalReference": "obsidian-typings!WorkspacesPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!YearFunction:interface", "docComment": "/**\n * Function `Year`.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface YearFunction extends " }, { "kind": "Reference", "text": "BasesFunction", "canonicalReference": "obsidian-typings!BasesFunction:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "HasExtract", "canonicalReference": "obsidian-typings!HasExtract:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/bases/functions/YearFunction.d.ts", "releaseTag": "Public", "name": "YearFunction", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ZkPrefixerPlugin:interface", "docComment": "/**\n * Internal plugin registration for the Zettelkasten ID prefixer feature.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ZkPrefixerPlugin extends " }, { "kind": "Reference", "text": "InternalPlugin", "canonicalReference": "obsidian-typings!InternalPlugin:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ZkPrefixerPluginInstance", "canonicalReference": "obsidian-typings!ZkPrefixerPluginInstance:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/zk-prefixer/ZkPrefixerPlugin.d.ts", "releaseTag": "Public", "name": "ZkPrefixerPlugin", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "obsidian-typings!ZkPrefixerPluginInstance:interface", "docComment": "/**\n * Plugin instance for the Zettelkasten prefixer, prepending unique IDs to new note filenames.\n *\n * @unofficial\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ZkPrefixerPluginInstance extends " }, { "kind": "Reference", "text": "InternalPluginInstance", "canonicalReference": "obsidian-typings!InternalPluginInstance:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ZkPrefixerPlugin", "canonicalReference": "obsidian-typings!ZkPrefixerPlugin:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/obsidian/internals/internal-plugins/zk-prefixer/ZkPrefixerPluginInstance.d.ts", "releaseTag": "Public", "name": "ZkPrefixerPluginInstance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ZkPrefixerPluginInstance#app:member", "docComment": "/**\n * Reference to the app.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "app: " }, { "kind": "Reference", "text": "App", "canonicalReference": "obsidian-typings!~App" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "obsidian-typings!ZkPrefixerPluginInstance#plugin:member", "docComment": "/**\n * Reference to the Zettelkasten prefixer plugin registration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "plugin: " }, { "kind": "Reference", "text": "ZkPrefixerPlugin", "canonicalReference": "obsidian-typings!ZkPrefixerPlugin:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "plugin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] } ] } ] }