getSearchIndex

获取搜索 API 索引。

⚠️

您需要安装 JSON:API 搜索 API 模块才能使用 getSearchIndex。

const resources = await drupal.getSearchIndex<T = JsonApiResource[]>(
  name,
  options?: {
    params,
    withAuth,
    deserialize,
    locale,
    defaultLocale,
  }
): Promise<T>
  • name: string
    • 必需
    • 搜索索引的名称。
  • options
    • 可选
    • params: JsonApiParams: JSON:API 参数，例如 filter、fields、include 或 sort。
    • withAuth: boolean | DrupalClientAuth:
      • 设置要使用的身份验证方法。请参阅 身份验证文档。
      • 设置为 true 以使用在客户端配置的身份验证方法。
    • deserialize: boolean: 设置为 false 以返回原始 JSON:API 响应。
    • locale: string: 要获取视图的语言环境。
    • defaultLocale: string: 网站的默认语言环境。

示例

  • 从名为 articles 的索引中获取搜索结果。
const results = await drupal.getSearchIndex("articles")

TypeScript

  • 使用 DrupalNode 作为节点实体类型。
import { DrupalNode } from "next-drupal"


const results = await drupal.getSearchIndex<DrupalNode>("articles")

查看 TypeScript 文档 以了解更多内置类型。

getViewbuildUrl