getView

从 Drupal 获取视图。

⚠️

您需要安装 JSON:API Views 模块才能使用 getView。

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

示例

  • 获取名为 articles 的视图并显示 id promoted。
const view = await drupal.getView("articles--promoted")
  • 使用稀疏字段集仅获取标题和正文字段。
const view = await drupal.getView("articles--promoted", {
  params: {
    fields: {
      "node--article": "title,body",
    },
  },
})

TypeScript

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


const view = await drupal.getView<DrupalNode>("articles--promoted")

有关更多内置类型的详细信息，请参阅 TypeScript 文档。

getMenugetSearchIndex