• Parse a UUID into its constituent parts, identifying the type and ID of the referenced document. The ResolvedUUID result also identifies a "primary" document which is a root-level document either in the game World or in a Compendium pack which is a parent of the referenced document.

    Parameters

    • uuid: string

      The UUID to parse.

    • Optional options: {
          relative: Document;
      } = {}

      Options to configure parsing behavior.

      • relative: Document

        A document to resolve relative UUIDs against.

    Returns ResolvedUUID

    Returns the Collection, Document Type, and Document ID to resolve the parent document, as well as the remaining Embedded Document parts, if any.

    Throws

    An error if the provided uuid string is incorrectly structured