Table of Contents

Function: load()

Call Signature

function load<S extends 
  | "bcf-2.1/markup"
  | "bcf-2.1/project"
  | "bcf-2.1/version"
  | "bcf-2.1/visinfo"
  | "bcf-3.0/documents"
  | "bcf-3.0/extensions"
  | "bcf-3.0/markup"
  | "bcf-3.0/project"
  | "bcf-3.0/version"
  | "bcf-3.0/visinfo">(source: string | ArrayBuffer | Uint8Array | Blob, options: Omit<{
  fallbackSpecification?: string;
  limits?: {
     maxEntries?: number;
     maxEntryBytes?: number;
     maxInputBytes?: number;
     maxTotalBytes?: number;
  };
  schema?: string;
  trimXmlDeclaration?: boolean;
  validate?: boolean;
}, "schema"> & {
  schema?:   | "bcf-2.1/markup"
     | "bcf-2.1/project"
     | "bcf-2.1/version"
     | "bcf-2.1/visinfo"
     | "bcf-3.0/documents"
     | "bcf-3.0/extensions"
     | "bcf-3.0/markup"
     | "bcf-3.0/project"
     | "bcf-3.0/version"
     | "bcf-3.0/visinfo";
} & {
  schema: S;
}): Promise<
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Markup;
  schema: "bcf-2.1/markup";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: ProjectExtension;
  schema: "bcf-2.1/project";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Version;
  schema: "bcf-2.1/version";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: VisualizationInfo;
  schema: "bcf-2.1/visinfo";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: DocumentInfo;
  schema: "bcf-3.0/documents";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Extensions;
  schema: "bcf-3.0/extensions";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Markup;
  schema: "bcf-3.0/markup";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: ProjectInfo;
  schema: "bcf-3.0/project";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Version;
  schema: "bcf-3.0/version";
}, {
  schema: S;
}>
  | Extract<{
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: VisualizationInfo;
  schema: "bcf-3.0/visinfo";
}, {
  schema: S;
}>>;

Read XML or a BCF archive, validating against the pinned official schemas by default.

Type Parameters

S

S extends | "bcf-2.1/markup" | "bcf-2.1/project" | "bcf-2.1/version" | "bcf-2.1/visinfo" | "bcf-3.0/documents" | "bcf-3.0/extensions" | "bcf-3.0/markup" | "bcf-3.0/project" | "bcf-3.0/version" | "bcf-3.0/visinfo"

Parameters

source

string | ArrayBuffer | Uint8Array | Blob

options

Omit<{ fallbackSpecification?: string; limits?: { maxEntries?: number; maxEntryBytes?: number; maxInputBytes?: number; maxTotalBytes?: number; }; schema?: string; trimXmlDeclaration?: boolean; validate?: boolean; }, "schema"> & { schema?: | "bcf-2.1/markup" | "bcf-2.1/project" | "bcf-2.1/version" | "bcf-2.1/visinfo" | "bcf-3.0/documents" | "bcf-3.0/extensions" | "bcf-3.0/markup" | "bcf-3.0/project" | "bcf-3.0/version" | "bcf-3.0/visinfo"; } & { schema: S; }

Returns

Promise< | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Markup; schema: "bcf-2.1/markup"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: ProjectExtension; schema: "bcf-2.1/project"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Version; schema: "bcf-2.1/version"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: VisualizationInfo; schema: "bcf-2.1/visinfo"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: DocumentInfo; schema: "bcf-3.0/documents"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Extensions; schema: "bcf-3.0/extensions"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Markup; schema: "bcf-3.0/markup"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: ProjectInfo; schema: "bcf-3.0/project"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Version; schema: "bcf-3.0/version"; }, { schema: S; }> | Extract<{ after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: VisualizationInfo; schema: "bcf-3.0/visinfo"; }, { schema: S; }>>

Call Signature

function load(source: string | ArrayBuffer | Uint8Array | Blob, options?: Omit<{
  fallbackSpecification?: string;
  limits?: {
     maxEntries?: number;
     maxEntryBytes?: number;
     maxInputBytes?: number;
     maxTotalBytes?: number;
  };
  schema?: string;
  trimXmlDeclaration?: boolean;
  validate?: boolean;
}, "schema"> & {
  schema?:   | "bcf-2.1/markup"
     | "bcf-2.1/project"
     | "bcf-2.1/version"
     | "bcf-2.1/visinfo"
     | "bcf-3.0/documents"
     | "bcf-3.0/extensions"
     | "bcf-3.0/markup"
     | "bcf-3.0/project"
     | "bcf-3.0/version"
     | "bcf-3.0/visinfo";
}): Promise<
  | {
  entries: Record<string, 
     | {
     date?: Date;
     document: {
        after?: (
           | {
           kind: ...;
           value: ...;
         }
           | {
           kind: ...;
           target: ...;
           value: ...;
        })[];
        before?: (
           | {
           kind: ...;
           value: ...;
         }
           | {
           kind: ...;
           target: ...;
           value: ...;
        })[];
        kind: "xml";
        root: {
           attributes: Record<string, ... | ...> & {
            [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
           };
           content: (
              | string
              | {
              kind: ...;
              value: ...;
            }
              | {
              kind: ...;
              target: ...;
              value: ...;
            }
              | {
              attributes: ...;
              content: ...;
              name: ...;
              namespaces?: ...;
              namespaceURI: ...;
              prefix?: ...;
           })[];
           name: string;
           namespaces?: Record<string, string>;
           namespaceURI: string;
           prefix?: string;
        };
        schema: string;
     };
   }
     | {
     bytes: Uint8Array;
     date?: Date;
  }>;
  kind: "archive";
  specification: string;
}
  | 
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Markup;
  schema: "bcf-2.1/markup";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: ProjectExtension;
  schema: "bcf-2.1/project";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Version;
  schema: "bcf-2.1/version";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: VisualizationInfo;
  schema: "bcf-2.1/visinfo";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: DocumentInfo;
  schema: "bcf-3.0/documents";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Extensions;
  schema: "bcf-3.0/extensions";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Markup;
  schema: "bcf-3.0/markup";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: ProjectInfo;
  schema: "bcf-3.0/project";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: Version;
  schema: "bcf-3.0/version";
}
  | {
  after?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  before?: (
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
  })[];
  kind: "xml";
  root: VisualizationInfo;
  schema: "bcf-3.0/visinfo";
}>;

Read XML or a BCF archive, validating against the pinned official schemas by default.

Parameters

source

string | ArrayBuffer | Uint8Array | Blob

options?

Omit<{ fallbackSpecification?: string; limits?: { maxEntries?: number; maxEntryBytes?: number; maxInputBytes?: number; maxTotalBytes?: number; }; schema?: string; trimXmlDeclaration?: boolean; validate?: boolean; }, "schema"> & { schema?: | "bcf-2.1/markup" | "bcf-2.1/project" | "bcf-2.1/version" | "bcf-2.1/visinfo" | "bcf-3.0/documents" | "bcf-3.0/extensions" | "bcf-3.0/markup" | "bcf-3.0/project" | "bcf-3.0/version" | "bcf-3.0/visinfo"; }

Returns

Promise< | { entries: Record<string, | { date?: Date; document: { after?: ( | { kind: ...; value: ...; } | { kind: ...; target: ...; value: ...; })[]; before?: ( | { kind: ...; value: ...; } | { kind: ...; target: ...; value: ...; })[]; kind: "xml"; root: { attributes: Record<string, ... | ...> & { [qualifiedName: `${(...)}:${(...)}`]: ... | ...; }; content: ( | string | { kind: ...; value: ...; } | { kind: ...; target: ...; value: ...; } | { attributes: ...; content: ...; name: ...; namespaces?: ...; namespaceURI: ...; prefix?: ...; })[]; name: string; namespaces?: Record<string, string>; namespaceURI: string; prefix?: string; }; schema: string; }; } | { bytes: Uint8Array; date?: Date; }>; kind: "archive"; specification: string; } | | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Markup; schema: "bcf-2.1/markup"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: ProjectExtension; schema: "bcf-2.1/project"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Version; schema: "bcf-2.1/version"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: VisualizationInfo; schema: "bcf-2.1/visinfo"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: DocumentInfo; schema: "bcf-3.0/documents"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Extensions; schema: "bcf-3.0/extensions"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Markup; schema: "bcf-3.0/markup"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: ProjectInfo; schema: "bcf-3.0/project"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: Version; schema: "bcf-3.0/version"; } | { after?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; before?: ( | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; })[]; kind: "xml"; root: VisualizationInfo; schema: "bcf-3.0/visinfo"; }>

Last updated on 2026-10-17
Raise issue