Interface SanityConfig

Represents the complete configuration for a Sanity SDK instance

interface SanityConfig {
    auth?: AuthConfig;
    dataset?: string;
    perspective?: ReleasePerspective | ClientPerspective;
    projectId?: string;
    studioMode?: { enabled: boolean };
}

Hierarchy (View Summary)

DatasetHandle
PerspectiveHandle
- SanityConfig

Index

Properties

auth? dataset? perspective? projectId? studioMode?

Properties

`Optional`auth

auth?: AuthConfig

Authentication configuration for the instance

Remarks

Merged with parent configurations when using createChild

`Optional`dataset

dataset?: string

`Optional`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional`projectId

projectId?: string

`Optional`studioMode

studioMode?: { enabled: boolean }

Studio mode configuration for use of the SDK in a Sanity Studio

Remarks

Controls whether studio mode features are enabled