obsidian-typings 2.41.0 → 2.41.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5211,8 +5211,8 @@ export interface PositionedReference extends Reference, CacheItem {
5211
5211
  }
5212
5212
  /** @public */
5213
5213
  export interface PromisedQueue {
5214
- promise: Promise<void>;
5215
- queue(next: () => void | Promise<void>): Promise<void>;
5214
+ promise: Promise<unknown>;
5215
+ queue<T>(fn: () => T | Promise<T>): Promise<T>;
5216
5216
  }
5217
5217
  /** @public */
5218
5218
  export interface PropertiesPlugin extends InternalPlugin<PropertiesPluginInstance> {
@@ -365,10 +365,28 @@ declare module "obsidian" {
365
365
  listRecursive(normalizedPath: string): Promise<void>;
366
366
  /** @internal */
367
367
  onFileChange(normalizedPath: string | null): void;
368
- /** @internal */
369
- reconcileDeletion(normalizedPath: string, normalizedNewPath: string, shouldRetryAfterTimeout?: boolean): Promise<void>;
370
- /** @internal */
371
- reconcileFile(normalizedPath: string, normalizedNewPath: string, shouldRetryAfterTimeout?: boolean): Promise<void>;
368
+ /**
369
+ * Reconcile a deletion.
370
+ *
371
+ * @param normalizedPath Path to file
372
+ * @param normalizedNewPath New path to file
373
+ * @param shouldSkipDeletionTimeout Whether the deletion timeout should be skipped (default: `true`)
374
+ * @returns A promise that resolves when the file is reconciled
375
+ *
376
+ * @internal
377
+ */
378
+ reconcileDeletion(normalizedPath: string, normalizedNewPath: string, shouldSkipDeletionTimeout?: boolean): Promise<void>;
379
+ /**
380
+ * Reconcile a file.
381
+ *
382
+ * @param normalizedPath Path to file
383
+ * @param normalizedNewPath New path to file
384
+ * @param shouldSkipDeletionTimeout Whether the deletion timeout should be skipped - applies only to {@link reconcileDeletion}
385
+ * @returns A promise that resolves when the file is reconciled
386
+ *
387
+ * @internal
388
+ */
389
+ reconcileFile(normalizedPath: string, normalizedNewPath: string, shouldSkipDeletionTimeout?: boolean): Promise<void>;
372
390
  /** @internal */
373
391
  reconcileFolderCreation(normalizedPath: string, normalizedNewPath: string): Promise<void>;
374
392
  /** @internal */
@@ -8475,8 +8493,8 @@ export interface PositionedReference extends Reference, CacheItem {
8475
8493
  }
8476
8494
  /** @public */
8477
8495
  export interface PromisedQueue {
8478
- promise: Promise<void>;
8479
- queue(next: () => void | Promise<void>): Promise<void>;
8496
+ promise: Promise<unknown>;
8497
+ queue<T>(fn: () => T | Promise<T>): Promise<T>;
8480
8498
  }
8481
8499
  /** @public */
8482
8500
  export interface PropertiesPlugin extends InternalPlugin<PropertiesPluginInstance> {
@@ -80727,7 +80727,7 @@
80727
80727
  },
80728
80728
  {
80729
80729
  "kind": "Content",
80730
- "text": "<void>"
80730
+ "text": "<unknown>"
80731
80731
  },
80732
80732
  {
80733
80733
  "kind": "Content",
@@ -80750,11 +80750,11 @@
80750
80750
  "excerptTokens": [
80751
80751
  {
80752
80752
  "kind": "Content",
80753
- "text": "queue(next: "
80753
+ "text": "queue<T>(fn: "
80754
80754
  },
80755
80755
  {
80756
80756
  "kind": "Content",
80757
- "text": "() => void | "
80757
+ "text": "() => T | "
80758
80758
  },
80759
80759
  {
80760
80760
  "kind": "Reference",
@@ -80763,7 +80763,7 @@
80763
80763
  },
80764
80764
  {
80765
80765
  "kind": "Content",
80766
- "text": "<void>"
80766
+ "text": "<T>"
80767
80767
  },
80768
80768
  {
80769
80769
  "kind": "Content",
@@ -80776,7 +80776,7 @@
80776
80776
  },
80777
80777
  {
80778
80778
  "kind": "Content",
80779
- "text": "<void>"
80779
+ "text": "<T>"
80780
80780
  },
80781
80781
  {
80782
80782
  "kind": "Content",
@@ -80792,7 +80792,7 @@
80792
80792
  "overloadIndex": 1,
80793
80793
  "parameters": [
80794
80794
  {
80795
- "parameterName": "next",
80795
+ "parameterName": "fn",
80796
80796
  "parameterTypeTokenRange": {
80797
80797
  "startIndex": 1,
80798
80798
  "endIndex": 4
@@ -80800,6 +80800,19 @@
80800
80800
  "isOptional": false
80801
80801
  }
80802
80802
  ],
80803
+ "typeParameters": [
80804
+ {
80805
+ "typeParameterName": "T",
80806
+ "constraintTokenRange": {
80807
+ "startIndex": 0,
80808
+ "endIndex": 0
80809
+ },
80810
+ "defaultTypeTokenRange": {
80811
+ "startIndex": 0,
80812
+ "endIndex": 0
80813
+ }
80814
+ }
80815
+ ],
80803
80816
  "name": "queue"
80804
80817
  }
80805
80818
  ],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "obsidian-typings",
3
- "version": "2.41.0",
3
+ "version": "2.41.2",
4
4
  "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
5
5
  "main": "",
6
6
  "module": "",