Sanity Library Reference Docs
    Preparing search index...

    Interface ReadBlueprintOptions

    Options for readBlueprint

    interface ReadBlueprintOptions {
        env?: ProcessEnv | null;
        loader?: BlueprintLoader;
        overrides?: Partial<BlueprintsApiConfig> | null;
        path?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    env? loader? overrides? path?

    Properties

    env?: ProcessEnv | null

    The environment to read. Defaults to process.env. Pass null to skip environment variables.

    loader?: BlueprintLoader

    Imports a JS or TS blueprint file in place of the built-in loading, for example to skip the module cache

    overrides?: Partial<BlueprintsApiConfig> | null

    Ids that win over every other source

    path?: string

    A blueprint file or directory. Defaults to the current working directory.

    Settings

    Member Visibility

    On This Page

    Properties