Type Alias DefinedSanityLiveStreamType

Type declaration

• • <const QueryString extends string>(
        props: {
            children: (
                result: {
                    data: ClientReturn<QueryString>;
                    sourceMap: ContentSourceMap | null;
                    tags: string[];
                },
            ) => Promise<Awaited<React.ReactNode>>;
            params?: QueryParams | Promise<QueryParams>;
            perspective?: Exclude<ClientPerspective, "raw">;
            query: QueryString;
            requestTag?: string;
            stega?: boolean;
            tag?: never;
            tags?: string[];
        },
    ): React.ReactNode

  • Type Parameters

    • const QueryString extends string

    Parameters

    • props: {
          children: (
              result: {
                  data: ClientReturn<QueryString>;
                  sourceMap: ContentSourceMap | null;
                  tags: string[];
              },
          ) => Promise<Awaited<React.ReactNode>>;
          params?: QueryParams | Promise<QueryParams>;
          perspective?: Exclude<ClientPerspective, "raw">;
          query: QueryString;
          requestTag?: string;
          stega?: boolean;
          tag?: never;
          tags?: string[];
      }

      • children: (
            result: {
                data: ClientReturn<QueryString>;
                sourceMap: ContentSourceMap | null;
                tags: string[];
            },
        ) => Promise<Awaited<React.ReactNode>>

      • Optionalparams?: QueryParams | Promise<QueryParams>

      • Optionalperspective?: Exclude<ClientPerspective, "raw">

      • query: QueryString

      • OptionalrequestTag?: string

        This request tag is used to identify the request when viewing request logs from your Sanity Content Lake.

        See

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

        Default Value

        'next-loader.live-stream.fetch'
        Copy

      • Optionalstega?: boolean

      • Optionaltag?: never

        Deprecated

        use requestTag instead

      • Optionaltags?: string[]

        Add custom next.tags to the underlying fetch request.

        See

        https://nextjs.org/docs/app/api-reference/functions/fetch#optionsnexttags This can be used in conjunction with custom fallback revalidation strategies, as well as with custom Server Actions that mutate data and want to render with fresh data right away (faster than the Live Event latency).

        Default Value

        ['sanity']

    Returns React.ReactNode