Interface SanityInstance

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

Remarks

Instances form a hierarchy through parent/child relationships

interface SanityInstance {
    config: SanityConfig;
    instanceId: string;
    createChild(config: SanityConfig): SanityInstance;
    dispose(): void;
    getParent(): undefined | SanityInstance;
    isDisposed(): boolean;
    match(targetConfig: Partial<SanityConfig>): undefined | SanityInstance;
    onDispose(cb: () => void): () => void;
}

Index

Properties

config instanceId

Methods

createChild dispose getParent isDisposed match onDispose

Properties

`Readonly`config

config: SanityConfig

Resolved configuration for this instance

Remarks

Merges values from parent instances where appropriate

`Readonly`instanceId

instanceId: string

Unique identifier for this instance

Remarks

Generated using crypto.randomUUID()

Methods

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
- Defined in store/createSanityInstance.ts:55

dispose

dispose(): void
Disposes the instance and cleans up associated resources

Returns void
Remarks
Triggers all registered onDispose callbacks
- Defined in store/createSanityInstance.ts:35

getParent

getParent(): undefined | SanityInstance
Gets the parent instance in the hierarchy

Returns undefined | SanityInstance
Parent instance or undefined if this is the root
- Defined in store/createSanityInstance.ts:48

isDisposed

isDisposed(): boolean
Checks if the instance has been disposed

Returns boolean
true if dispose() has been called
- Defined in store/createSanityInstance.ts:29

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.
- Defined in store/createSanityInstance.ts:63

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
- Defined in store/createSanityInstance.ts:42