mockFromUuid

mockFromUuid mocks Foundry’s fromUuid utility method so that you can test code that uses it.

Parameters

documents?: Record<string, foundry.abstract.Document>

A record of Foundry Documents by UUID that you would like the mock to provide.

Examples

import { beforeEach, afterEach, describe, expect, it, vi } from 'vitest'
import { mockFromUuid } from '@revolutionarygamesco/common-foundryvtt/mocks'
import { getActorName } from './get-actor-name.ts'

describe('getActorName', () => {
  beforeEach(() => {
    mockFromUuid({
      'Actor.1111111111111111': { name: 'John Doe' } as foundry.documents.Actor
    })
  })

  afterEach(() => {
    vi.unstubAllGlobals()
  })

  it('resolves the document and returns its name', async () => {
    expect(await getActorName('Actor.1111111111111111')).toBe('John Doe')
  })

  it('returns null when the UUID resolves to nothing', async () => {
    expect(await getActorName('Actor.2222222222222222')).toBeNull()
  })
})