Sanity Library Reference Docs
    Preparing search index...

    Interface SanityInstance

    Represents a Sanity.io resource instance with its own configuration and lifecycle

    interface SanityInstance {
        config: SanityConfig;
        instanceId: string;
        dispose(): void;
        isDisposed(): boolean;
        onDispose(cb: () => void): () => void;
    }
    Index

    Properties

    config instanceId

    Methods

    dispose isDisposed onDispose

    Properties

    config: SanityConfig

    Resolved configuration for this instance

    instanceId: string

    Unique identifier for this instance

    Generated as a random 16-character alphanumeric ID

    Methods

    • Disposes the instance and cleans up associated resources

      Returns void

      Triggers all registered onDispose callbacks

    • 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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods