Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowClientConfig

    The config bag WorkflowClient.withConfig accepts — all optional: a resource rebind (resource, plus the dataset pair for dataset targets), an apiVersion rebind, a request-tag prefix, or any combination. Everything omitted is inherited from the source client.

    interface WorkflowClientConfig {
        apiHost?: string;
        apiVersion?: string;
        dataset?: string;
        projectId?: string;
        requestTagPrefix?: string;
        resource?: WorkflowResource;
        useProjectHostname?: boolean;
    }
    Index

    Properties

    apiHost? apiVersion? dataset? projectId? requestTagPrefix? resource? useProjectHostname?

    Properties

    apiHost?: string

    Explicit API origin, mirroring @sanity/client's apiHost.

    apiVersion?: string
    dataset?: string
    projectId?: string
    requestTagPrefix?: string
    resource?: WorkflowResource
    useProjectHostname?: boolean

    Host selection, mirroring @sanity/client: false derives a sibling addressing the global API host instead of the project host. The engine uses this for exactly one read — resolving the acting token's account-global identity from the global /users/me.

    Settings

    Member Visibility

    On This Page

    Properties