• Retrieve a Document by its Universally Unique Identifier (uuid) synchronously. If the uuid resolves to a compendium document, that document's index entry will be returned instead.

    Parameters

    • uuid: string

      The uuid of the Document to retrieve.

    • Optionaloptions: {
          invalid?: boolean;
          relative?: Document<object, DocumentConstructionContext>;
          strict?: boolean;
      } = {}

      Options to configure how a UUID is resolved.

      • Optionalinvalid?: boolean

        Allow retrieving an invalid Document.

      • Optionalrelative?: Document<object, DocumentConstructionContext>

        A Document to resolve relative UUIDs against.

      • Optionalstrict?: boolean

        Throw an error if the UUID cannot be resolved synchronously.

    Returns null | object | Document<object, DocumentConstructionContext>

    The Document or its index entry if it resides in a Compendium, otherwise null.

    If the uuid resolves to a Document that cannot be retrieved synchronously, and the strict option is true.