getResourceCollection

获取资源集合。

const resource = await drupal.getResourceCollection<T = JsonApiResource[]>(
  type,
  options?: {
    params,
    withAuth,
    deserialize,
    locale,
    defaultLocale,
  }
): Promise<T>
  • type: string
    • 必填
    • 资源类型。例如：node--article 或 user--user。
  • options
    • 可选
    • params: JsonApiParams: JSON:API 参数，例如 filter, fields, include 或 sort。
    • withAuth: boolean | DrupalClientAuth:
      • 设置要使用的身份验证方法。查看 身份验证文档。
      • 设置为 true 以使用客户端配置的身份验证方法。
    • deserialize: boolean: 设置为 false 以返回原始 JSON:API 响应。
    • locale: string: 要获取资源的语言环境。
    • defaultLocale: string: 站点的默认语言环境。

示例

  • 获取所有文章。
const articles = await drupal.getResourceCollection("node--article")
  • 使用过滤器。
const publishedArticles = await drupal.getResourceCollection("node--article", {
  params: {
    "filter[status]": "1",
  },
})
  • 获取原始 JSON:API 响应。
const { data, meta, links } = await drupal.getResourceCollection("node--page", {
  deserialize: false,
})

TypeScript

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


const nodes = await drupal.getResourceCollection<DrupalNode[]>("node--article")

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

getResourceByPathgetResourceCollectionFromContext