📆 Don't miss our Sanity Showcase virtual meetup on March 20th!
@public
interface

MigrationContext

Migration context. This will be passed to both async iterable migrations and node migration helper functions

Import

import {type MigrationContext} from 'sanity/migrate'

Signature

interface MigrationContext {
  client: RestrictedClient
  dryRun: boolean
  filtered: {
    getDocument<T extends SanityDocument_2>(id: string): Promise<T | undefined>
    getDocuments<T extends SanityDocument_2>(ids: string[]): Promise<T[]>
  }
}

Properties

client: RestrictedClient
client: RestrictedClient
dryRun: boolean
dryRun: boolean
filtered: {
  getDocument<T extends SanityDocument_2>(id: string): Promise<T | undefined>
  getDocuments<T extends SanityDocument_2>(ids: string[]): Promise<T[]>
}
filtered: {
  getDocument<T extends SanityDocument_2>(id: string): Promise<T | undefined>
  getDocuments<T extends SanityDocument_2>(ids: string[]): Promise<T[]>
}
sanity@3.79.0