obsidian-typings 2.36.0 → 2.36.1

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.
@@ -2602,8 +2602,10 @@ export interface ElectronWindow extends BrowserWindow {
2602
2602
  _eventsCount: unknown;
2603
2603
  devToolsWebContents: unknown;
2604
2604
  }
2605
+ /** @public */
2605
2606
  export interface EmbedAudioComponent extends Component {
2606
2607
  }
2608
+ /** @public */
2607
2609
  export interface EmbedCanvasComponent extends Component {
2608
2610
  }
2609
2611
  /** @public */
@@ -2639,10 +2641,13 @@ export interface EmbedContext {
2639
2641
  /** @internal */
2640
2642
  state?: unknown;
2641
2643
  }
2644
+ /** @public */
2642
2645
  export interface EmbedImageComponent extends Component {
2643
2646
  }
2647
+ /** @public */
2644
2648
  export interface EmbedMarkdownComponent extends Component {
2645
2649
  }
2650
+ /** @public */
2646
2651
  export interface EmbedPdfComponent extends Component {
2647
2652
  }
2648
2653
  /** @public */
@@ -2703,6 +2708,7 @@ export interface EmbedRegistryEmbedByExtensionRecord extends Record<string, Embe
2703
2708
  [FileExtension.webm]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
2704
2709
  [FileExtension.webp]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
2705
2710
  }
2711
+ /** @public */
2706
2712
  export interface EmbedVideoComponent extends Component {
2707
2713
  }
2708
2714
  /** @public */
@@ -3213,7 +3219,7 @@ export interface FileSuggestManager {
3213
3219
  */
3214
3220
  matchBlock(path: string, file: TFile, block: BlockCache, sourcePath: null | string, content: string, text_parts: string[]): SearchResult | null;
3215
3221
  }
3216
- /** @internal */
3222
+ /** @public */
3217
3223
  export interface FileSystemWatchHandler {
3218
3224
  (eventType: "raw" | "folder-created" | "folder-removed" | "file-removed", path: string): void;
3219
3225
  (eventType: "modified" | "file-created", path: string, oldPath: undefined, stats: FileStats): void;
@@ -3375,6 +3381,7 @@ export interface GraphEngine {
3375
3381
  */
3376
3382
  updateSearch(): void;
3377
3383
  }
3384
+ /** @public */
3378
3385
  export interface GraphFileFilter extends Record<string, GraphColorAttributes | boolean> {
3379
3386
  }
3380
3387
  /** @public */
@@ -5834,8 +5834,10 @@ export interface ElectronWindow extends BrowserWindow {
5834
5834
  _eventsCount: unknown;
5835
5835
  devToolsWebContents: unknown;
5836
5836
  }
5837
+ /** @public */
5837
5838
  export interface EmbedAudioComponent extends Component {
5838
5839
  }
5840
+ /** @public */
5839
5841
  export interface EmbedCanvasComponent extends Component {
5840
5842
  }
5841
5843
  /** @public */
@@ -5871,10 +5873,13 @@ export interface EmbedContext {
5871
5873
  /** @internal */
5872
5874
  state?: unknown;
5873
5875
  }
5876
+ /** @public */
5874
5877
  export interface EmbedImageComponent extends Component {
5875
5878
  }
5879
+ /** @public */
5876
5880
  export interface EmbedMarkdownComponent extends Component {
5877
5881
  }
5882
+ /** @public */
5878
5883
  export interface EmbedPdfComponent extends Component {
5879
5884
  }
5880
5885
  /** @public */
@@ -5935,6 +5940,7 @@ export interface EmbedRegistryEmbedByExtensionRecord extends Record<string, Embe
5935
5940
  [FileExtension.webm]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
5936
5941
  [FileExtension.webp]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
5937
5942
  }
5943
+ /** @public */
5938
5944
  export interface EmbedVideoComponent extends Component {
5939
5945
  }
5940
5946
  /** @public */
@@ -6445,7 +6451,7 @@ export interface FileSuggestManager {
6445
6451
  */
6446
6452
  matchBlock(path: string, file: TFile, block: BlockCache, sourcePath: null | string, content: string, text_parts: string[]): SearchResult | null;
6447
6453
  }
6448
- /** @internal */
6454
+ /** @public */
6449
6455
  export interface FileSystemWatchHandler {
6450
6456
  (eventType: "raw" | "folder-created" | "folder-removed" | "file-removed", path: string): void;
6451
6457
  (eventType: "modified" | "file-created", path: string, oldPath: undefined, stats: FileStats): void;
@@ -6607,6 +6613,7 @@ export interface GraphEngine {
6607
6613
  */
6608
6614
  updateSearch(): void;
6609
6615
  }
6616
+ /** @public */
6610
6617
  export interface GraphFileFilter extends Record<string, GraphColorAttributes | boolean> {
6611
6618
  }
6612
6619
  /** @public */
@@ -47501,7 +47501,7 @@
47501
47501
  {
47502
47502
  "kind": "Interface",
47503
47503
  "canonicalReference": "obsidian-typings!EmbedAudioComponent:interface",
47504
- "docComment": "",
47504
+ "docComment": "/**\n * @public\n */\n",
47505
47505
  "excerptTokens": [
47506
47506
  {
47507
47507
  "kind": "Content",
@@ -47532,7 +47532,7 @@
47532
47532
  {
47533
47533
  "kind": "Interface",
47534
47534
  "canonicalReference": "obsidian-typings!EmbedCanvasComponent:interface",
47535
- "docComment": "",
47535
+ "docComment": "/**\n * @public\n */\n",
47536
47536
  "excerptTokens": [
47537
47537
  {
47538
47538
  "kind": "Content",
@@ -48800,7 +48800,7 @@
48800
48800
  {
48801
48801
  "kind": "Interface",
48802
48802
  "canonicalReference": "obsidian-typings!EmbedImageComponent:interface",
48803
- "docComment": "",
48803
+ "docComment": "/**\n * @public\n */\n",
48804
48804
  "excerptTokens": [
48805
48805
  {
48806
48806
  "kind": "Content",
@@ -48831,7 +48831,7 @@
48831
48831
  {
48832
48832
  "kind": "Interface",
48833
48833
  "canonicalReference": "obsidian-typings!EmbedMarkdownComponent:interface",
48834
- "docComment": "",
48834
+ "docComment": "/**\n * @public\n */\n",
48835
48835
  "excerptTokens": [
48836
48836
  {
48837
48837
  "kind": "Content",
@@ -48862,7 +48862,7 @@
48862
48862
  {
48863
48863
  "kind": "Interface",
48864
48864
  "canonicalReference": "obsidian-typings!EmbedPdfComponent:interface",
48865
- "docComment": "",
48865
+ "docComment": "/**\n * @public\n */\n",
48866
48866
  "excerptTokens": [
48867
48867
  {
48868
48868
  "kind": "Content",
@@ -50724,7 +50724,7 @@
50724
50724
  {
50725
50725
  "kind": "Interface",
50726
50726
  "canonicalReference": "obsidian-typings!EmbedVideoComponent:interface",
50727
- "docComment": "",
50727
+ "docComment": "/**\n * @public\n */\n",
50728
50728
  "excerptTokens": [
50729
50729
  {
50730
50730
  "kind": "Content",
@@ -55357,6 +55357,293 @@
55357
55357
  ],
55358
55358
  "extendsTokenRanges": []
55359
55359
  },
55360
+ {
55361
+ "kind": "Interface",
55362
+ "canonicalReference": "obsidian-typings!FileSystemWatchHandler:interface",
55363
+ "docComment": "/**\n * @public\n */\n",
55364
+ "excerptTokens": [
55365
+ {
55366
+ "kind": "Content",
55367
+ "text": "export interface FileSystemWatchHandler "
55368
+ }
55369
+ ],
55370
+ "fileUrlPath": "src/obsidian/internals/FileSystemWatchHandler.d.ts",
55371
+ "releaseTag": "Public",
55372
+ "name": "FileSystemWatchHandler",
55373
+ "preserveMemberOrder": false,
55374
+ "members": [
55375
+ {
55376
+ "kind": "CallSignature",
55377
+ "canonicalReference": "obsidian-typings!FileSystemWatchHandler:call(1)",
55378
+ "docComment": "",
55379
+ "excerptTokens": [
55380
+ {
55381
+ "kind": "Content",
55382
+ "text": "(eventType: "
55383
+ },
55384
+ {
55385
+ "kind": "Content",
55386
+ "text": "'raw' | 'folder-created' | 'folder-removed' | 'file-removed'"
55387
+ },
55388
+ {
55389
+ "kind": "Content",
55390
+ "text": ", path: "
55391
+ },
55392
+ {
55393
+ "kind": "Content",
55394
+ "text": "string"
55395
+ },
55396
+ {
55397
+ "kind": "Content",
55398
+ "text": "): "
55399
+ },
55400
+ {
55401
+ "kind": "Content",
55402
+ "text": "void"
55403
+ },
55404
+ {
55405
+ "kind": "Content",
55406
+ "text": ";"
55407
+ }
55408
+ ],
55409
+ "returnTypeTokenRange": {
55410
+ "startIndex": 5,
55411
+ "endIndex": 6
55412
+ },
55413
+ "releaseTag": "Public",
55414
+ "overloadIndex": 1,
55415
+ "parameters": [
55416
+ {
55417
+ "parameterName": "eventType",
55418
+ "parameterTypeTokenRange": {
55419
+ "startIndex": 1,
55420
+ "endIndex": 2
55421
+ },
55422
+ "isOptional": false
55423
+ },
55424
+ {
55425
+ "parameterName": "path",
55426
+ "parameterTypeTokenRange": {
55427
+ "startIndex": 3,
55428
+ "endIndex": 4
55429
+ },
55430
+ "isOptional": false
55431
+ }
55432
+ ]
55433
+ },
55434
+ {
55435
+ "kind": "CallSignature",
55436
+ "canonicalReference": "obsidian-typings!FileSystemWatchHandler:call(2)",
55437
+ "docComment": "",
55438
+ "excerptTokens": [
55439
+ {
55440
+ "kind": "Content",
55441
+ "text": "(eventType: "
55442
+ },
55443
+ {
55444
+ "kind": "Content",
55445
+ "text": "'modified' | 'file-created'"
55446
+ },
55447
+ {
55448
+ "kind": "Content",
55449
+ "text": ", path: "
55450
+ },
55451
+ {
55452
+ "kind": "Content",
55453
+ "text": "string"
55454
+ },
55455
+ {
55456
+ "kind": "Content",
55457
+ "text": ", oldPath: "
55458
+ },
55459
+ {
55460
+ "kind": "Content",
55461
+ "text": "undefined"
55462
+ },
55463
+ {
55464
+ "kind": "Content",
55465
+ "text": ", stats: "
55466
+ },
55467
+ {
55468
+ "kind": "Reference",
55469
+ "text": "FileStats",
55470
+ "canonicalReference": "obsidian!FileStats:interface"
55471
+ },
55472
+ {
55473
+ "kind": "Content",
55474
+ "text": "): "
55475
+ },
55476
+ {
55477
+ "kind": "Content",
55478
+ "text": "void"
55479
+ },
55480
+ {
55481
+ "kind": "Content",
55482
+ "text": ";"
55483
+ }
55484
+ ],
55485
+ "returnTypeTokenRange": {
55486
+ "startIndex": 9,
55487
+ "endIndex": 10
55488
+ },
55489
+ "releaseTag": "Public",
55490
+ "overloadIndex": 2,
55491
+ "parameters": [
55492
+ {
55493
+ "parameterName": "eventType",
55494
+ "parameterTypeTokenRange": {
55495
+ "startIndex": 1,
55496
+ "endIndex": 2
55497
+ },
55498
+ "isOptional": false
55499
+ },
55500
+ {
55501
+ "parameterName": "path",
55502
+ "parameterTypeTokenRange": {
55503
+ "startIndex": 3,
55504
+ "endIndex": 4
55505
+ },
55506
+ "isOptional": false
55507
+ },
55508
+ {
55509
+ "parameterName": "oldPath",
55510
+ "parameterTypeTokenRange": {
55511
+ "startIndex": 5,
55512
+ "endIndex": 6
55513
+ },
55514
+ "isOptional": false
55515
+ },
55516
+ {
55517
+ "parameterName": "stats",
55518
+ "parameterTypeTokenRange": {
55519
+ "startIndex": 7,
55520
+ "endIndex": 8
55521
+ },
55522
+ "isOptional": false
55523
+ }
55524
+ ]
55525
+ },
55526
+ {
55527
+ "kind": "CallSignature",
55528
+ "canonicalReference": "obsidian-typings!FileSystemWatchHandler:call(3)",
55529
+ "docComment": "",
55530
+ "excerptTokens": [
55531
+ {
55532
+ "kind": "Content",
55533
+ "text": "(eventType: "
55534
+ },
55535
+ {
55536
+ "kind": "Content",
55537
+ "text": "'renamed'"
55538
+ },
55539
+ {
55540
+ "kind": "Content",
55541
+ "text": ", path: "
55542
+ },
55543
+ {
55544
+ "kind": "Content",
55545
+ "text": "string"
55546
+ },
55547
+ {
55548
+ "kind": "Content",
55549
+ "text": ", oldPath: "
55550
+ },
55551
+ {
55552
+ "kind": "Content",
55553
+ "text": "string"
55554
+ },
55555
+ {
55556
+ "kind": "Content",
55557
+ "text": "): "
55558
+ },
55559
+ {
55560
+ "kind": "Content",
55561
+ "text": "void"
55562
+ },
55563
+ {
55564
+ "kind": "Content",
55565
+ "text": ";"
55566
+ }
55567
+ ],
55568
+ "returnTypeTokenRange": {
55569
+ "startIndex": 7,
55570
+ "endIndex": 8
55571
+ },
55572
+ "releaseTag": "Public",
55573
+ "overloadIndex": 3,
55574
+ "parameters": [
55575
+ {
55576
+ "parameterName": "eventType",
55577
+ "parameterTypeTokenRange": {
55578
+ "startIndex": 1,
55579
+ "endIndex": 2
55580
+ },
55581
+ "isOptional": false
55582
+ },
55583
+ {
55584
+ "parameterName": "path",
55585
+ "parameterTypeTokenRange": {
55586
+ "startIndex": 3,
55587
+ "endIndex": 4
55588
+ },
55589
+ "isOptional": false
55590
+ },
55591
+ {
55592
+ "parameterName": "oldPath",
55593
+ "parameterTypeTokenRange": {
55594
+ "startIndex": 5,
55595
+ "endIndex": 6
55596
+ },
55597
+ "isOptional": false
55598
+ }
55599
+ ]
55600
+ },
55601
+ {
55602
+ "kind": "CallSignature",
55603
+ "canonicalReference": "obsidian-typings!FileSystemWatchHandler:call(4)",
55604
+ "docComment": "",
55605
+ "excerptTokens": [
55606
+ {
55607
+ "kind": "Content",
55608
+ "text": "(eventType: "
55609
+ },
55610
+ {
55611
+ "kind": "Content",
55612
+ "text": "'closed'"
55613
+ },
55614
+ {
55615
+ "kind": "Content",
55616
+ "text": "): "
55617
+ },
55618
+ {
55619
+ "kind": "Content",
55620
+ "text": "void"
55621
+ },
55622
+ {
55623
+ "kind": "Content",
55624
+ "text": ";"
55625
+ }
55626
+ ],
55627
+ "returnTypeTokenRange": {
55628
+ "startIndex": 3,
55629
+ "endIndex": 4
55630
+ },
55631
+ "releaseTag": "Public",
55632
+ "overloadIndex": 4,
55633
+ "parameters": [
55634
+ {
55635
+ "parameterName": "eventType",
55636
+ "parameterTypeTokenRange": {
55637
+ "startIndex": 1,
55638
+ "endIndex": 2
55639
+ },
55640
+ "isOptional": false
55641
+ }
55642
+ ]
55643
+ }
55644
+ ],
55645
+ "extendsTokenRanges": []
55646
+ },
55360
55647
  {
55361
55648
  "kind": "Interface",
55362
55649
  "canonicalReference": "obsidian-typings!FileTreeItem:interface",
@@ -57512,7 +57799,7 @@
57512
57799
  {
57513
57800
  "kind": "Interface",
57514
57801
  "canonicalReference": "obsidian-typings!GraphFileFilter:interface",
57515
- "docComment": "",
57802
+ "docComment": "/**\n * @public\n */\n",
57516
57803
  "excerptTokens": [
57517
57804
  {
57518
57805
  "kind": "Content",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "obsidian-typings",
3
- "version": "2.36.0",
3
+ "version": "2.36.1",
4
4
  "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
5
5
  "main": "",
6
6
  "module": "",