Interface SanityInstance

Readonlyconfig

ReadonlyinstanceId

createChild

• createChild(config: SanityConfig): SanityInstance

  Creates a child instance with merged configuration

  Parameters

  • config: SanityConfig

    Configuration to merge with parent values

  Returns SanityInstance

  Remarks

  Child instances inherit parent configuration but can override values

dispose

• dispose(): void

  Disposes the instance and cleans up associated resources

  Returns void

  Remarks

  Triggers all registered onDispose callbacks

getParent

• getParent(): undefined | SanityInstance

  Gets the parent instance in the hierarchy

  Returns undefined | SanityInstance

  Parent instance or undefined if this is the root

isDisposed

• isDisposed(): boolean

  Checks if the instance has been disposed

  Returns boolean

  true if dispose() has been called

match

• match(targetConfig: Partial<SanityConfig>): undefined | SanityInstance

  Traverses the instance hierarchy to find the first instance whose configuration matches the given target config using a shallow comparison.

  Parameters

  • targetConfig: Partial<SanityConfig>

    A partial configuration object containing key-value pairs to match.

  Returns undefined | SanityInstance

  The first matching instance or undefined if no match is found.

onDispose

• onDispose(cb: () => void): () => void

  Registers a callback to be invoked when the instance is disposed

  Parameters

  • cb: () => void

    Callback to execute on disposal

  Returns () => void

  Function to unsubscribe the callback