Sanity Library Reference Docs
    Preparing search index...

    Interface StegaConfig

    interface StegaConfig {
        enabled?: boolean;
        filter?: FilterDefault;
        logger?: Logger;
        omitCrossDatasetReferenceData?: boolean;
        studioUrl?: StudioUrl | ResolveStudioUrl;
    }
    Index

    Properties

    enabled? filter? logger? omitCrossDatasetReferenceData? studioUrl?

    Properties

    enabled?: boolean

    Enable or disable stega encoded strings in query results

     {
       enabled: process.env.VERCEL_ENV !== 'production'
     }

    false

    filter?: FilterDefault
    logger?: Logger

    Specify a console.log compatible logger to see debug logs, which keys are encoded and which are not.

    omitCrossDatasetReferenceData?: boolean

    Set to true to omit cross dataset reference specific data from encoded strings

    studioUrl?: StudioUrl | ResolveStudioUrl

    Where the Studio is hosted. If it's embedded in the app, use the base path for example /studio. Otherwise provide the full URL to where the Studio is hosted, for example: https://blog.sanity.studio.

    Settings

    Member Visibility

    On This Page

    Properties