Type Alias DefinedFetchType

Type declaration

• • <const QueryString extends string>(
        options: {
            params?: QueryParams | Promise<QueryParams>;
            perspective?: LivePerspective;
            query: QueryString;
            requestTag?: string;
            stega?: boolean;
            tags?: string[];
        },
    ): Promise<
        {
            data: ClientReturn<QueryString, unknown>;
            sourceMap: ContentSourceMap | null;
            tags: string[];
        },
    >

  • Type Parameters

    • const QueryString extends string

    Parameters

    • options: {
          params?: QueryParams | Promise<QueryParams>;
          perspective?: LivePerspective;
          query: QueryString;
          requestTag?: string;
          stega?: boolean;
          tags?: string[];
      }

      • Optionalparams?: QueryParams | Promise<QueryParams>

        Parameters used by the GROQ query.

      • Optionalperspective?: LivePerspective

        Content perspective used for the fetch.

        Remarks

        Requires serverToken to be configured in defineLive()

        Default Value

        The default is 'published' unless

        • Cache Components are disabled
        • defineLive() was given a serverToken
        • defineLive() is not set to strict: true
        • draftMode() is enabled

        If all of the above conditions are met, then the default value will be resolved from attempting to read the 'sanity-preview-perspective' cookie and fall back to 'drafts' if not set

      • query: QueryString

        GROQ query to execute.

      • OptionalrequestTag?: string

        Request tag used to identify the request in Sanity Content Lake logs.

        See

        https://www.sanity.io/docs/reference-api-request-tags

        Default Value

        If cacheComponents: true then the default value is 'next-loader.fetch.cache-components' otherwise it's 'next-loader.fetch'

      • Optionalstega?: boolean

        Enables stega encoding of the data. This is typically only used in draft mode with perspective: 'drafts' and @sanity/visual-editing.

        Remarks

        Requires serverToken to be configured in defineLive()

        Default Value

        The default is false unless

        • Cache Components are disabled
        • defineLive() was given a serverToken
        • defineLive() is not set to strict: true
        • defineLive() was given a client that defines stega.studioUrl
        • draftMode() is enabled

        If all of the above conditions are met, then the default value will be true

      • Optionaltags?: string[]

        Additional cache tags to associate with this fetch.

        Remarks

        The default behavior will always add cache tags automatically for the query based on the syncTags response returned by Content Lake. You only need to define custom tags if you also mutate content in a server action and need to implement read-your-own-write UI.

        See

        • https://nextjs.org/docs/app/api-reference/functions/updateTag#server-action-with-read-your-own-writes

        When cacheComponents: false your custom tags are appended to the underlying next.tags array on the fetch request and are subject to the tag length and max tag items limits of Next.js.

        • https://nextjs.org/docs/app/api-reference/functions/fetch#optionsnexttags When cacheComponents: true your custom tags are appended to the underlying cacheTag() call and are subject to the tag length and max tag items limits of Next.js.
        • https://nextjs.org/docs/app/api-reference/functions/cacheTag#good-to-know

    Returns Promise<
        {
            data: ClientReturn<QueryString, unknown>;
            sourceMap: ContentSourceMap | null;
            tags: string[];
        },
    >