Sanity Library Reference Docs
    Preparing search index...

    Interface SanityConfig

    Represents the complete configuration for a Sanity SDK instance

    interface SanityConfig {
        auth?: AuthConfig;
        dataset?: string;
        perspective?: ReleasePerspective | ClientPerspective;
        projectId?: string;
        source?: DocumentSource;
        sourceName?: string;
        sources?: Record<string, DocumentSource>;
        studioMode?: { enabled: boolean };
    }

    Hierarchy (View Summary)

    Index

    Properties

    auth? dataset? perspective? projectId? source? sourceName? sources? studioMode?

    Properties

    auth?: AuthConfig

    Authentication configuration for the instance

    Merged with parent configurations when using createChild

    dataset?: string
    perspective?: ReleasePerspective | ClientPerspective
    projectId?: string
    source?: DocumentSource

    Explicit source object to use for this operation.

    sourceName?: string

    The name of the source to use for this operation.

    sources?: Record<string, DocumentSource>

    A list of named sources to use for this instance.

    studioMode?: { enabled: boolean }

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

    Controls whether studio mode features are enabled

    Settings

    Member Visibility

    On This Page

    Properties