@usearazzo/runner 1.0.1-alpha.17 → 1.0.1-alpha.18

package/types/runner.d.ts

@@ -185,6 +185,7 @@ export declare class ArazzoRunner {
      * Loads the entry Arazzo document at `uri` (a file system path or URL) and
      * returns a runner bound to it.
      *
+     * @throws DocumentLoadError - When the document cannot be read or loaded
      * @throws UnmatchedProviderError - When no provider can load the document
      * @throws InvalidEntryDocumentError - When the document is not an Arazzo
      * document, or the given registry already backs another entry document
@@ -544,6 +545,11 @@ export declare interface CriterionEvaluatorOptions {
  */
 export declare type CriterionPredicate = (criterion: CriterionElement) => boolean;
 
+/** @public */
+export declare class DocumentLoadError extends ArazzoRunnerError {
+    readonly uri?: string;
+}
+
 /**
  * Registry for API documents keyed by canonical URI.
  *
@@ -563,6 +569,9 @@ export declare class DocumentRegistry {
      * Acquires a document by URI. Returns cached document if available,
      * otherwise detects the format, loads via the matching provider,
      * caches, and returns it.
+     *
+     * @throws DocumentLoadError - When the document cannot be read or loaded
+     * @throws UnmatchedProviderError - When no provider can load the document
      */
     acquire(uri: string): Promise<APIDocument>;
     /**
@@ -578,6 +587,10 @@ export declare class DocumentRegistry {
     /**
      * Acquires the entry Arazzo document and marks it with `isEntry: true`.
      * Validates that the document is an Arazzo specification.
+     *
+     * @throws DocumentLoadError - When the document cannot be read or loaded
+     * @throws UnmatchedProviderError - When no provider can load the document
+     * @throws InvalidEntryDocumentError - When the document is not an Arazzo document
      */
     acquireEntryDocument(uri: string): Promise<ArazzoDocument>;
     clear(): void;