Sanity Library Reference Docs
    Preparing search index...

    Interface BaseIntentParams

    Base intent parameters

    dedupe with core/structure

    interface BaseIntentParams {
        id?: string;
        mode?: string;
        path?: string;
        template?: string;
        type?: string;
        [key: string]: string;
    }

    Indexable

    • [key: string]: string

      Arbitrary/custom parameters are generally discouraged - try to keep them to a minimum, or use payload (arbitrary JSON-serializable object) instead.

    Index

    Properties

    id? mode? path? template? type?

    Properties

    id?: string

    ID of the document to create/edit. Required for edit intents, optional for create.

    mode?: string

    Optional "mode" to use for edit intent. Known modes are structure and presentation.

    path?: string

    Experimental field path

    template?: string
    type?: string

    Document schema type name to create/edit. Required for create intents, optional for edit (but encouraged, safer and faster)

    Settings

    Member Visibility

    On This Page

    Properties