强大的类型化查询生成器：sanity-typed-queries-CSDN博客

本文链接：https://blog.csdn.net/gitblog_01110/article/details/142244979

🔤 强大的类型化查询生成器：sanity-typed-queries

sanity-typed-queries A typed, zero-dependency schema generator and query builder for Sanity. 项目地址: https://gitcode.com/gh_mirrors/sa/sanity-typed-queries

项目介绍

sanity-typed-queries 是一个为 Sanity 设计的类型化查询生成器，旨在为开发者提供一个零依赖、全类型化的查询构建工具。无论你是使用 JavaScript 还是 TypeScript，sanity-typed-queries 都能帮助你轻松生成符合 Sanity 规范的查询语句，并提供强大的类型检查和自动补全功能。

项目技术分析

技术栈

TypeScript: 项目完全使用 TypeScript 编写，确保了类型安全和代码的可维护性。
Sanity: 专为 Sanity 平台设计，无缝集成 Sanity 的查询语言 GROQ。
零依赖: 项目本身不依赖任何外部库，确保了轻量级和高效性。

核心功能

类型化 Schema 构建: 通过 defineDocument 和 defineObject 等函数，开发者可以轻松定义类型化的 Sanity Schema。
查询构建器: 支持字符串、布尔值、数字等基本类型的查询，并提供排序、投影等功能。
自定义映射: 允许开发者自定义字段映射，如 "prop": my.prop。
图像和文件类型解析: 自动解析图像和文件类型，简化开发流程。

项目及技术应用场景

sanity-typed-queries 适用于以下场景：

内容管理系统 (CMS): 为 Sanity 构建的 CMS 提供类型安全的查询支持。
数据驱动应用: 在需要从 Sanity 获取数据的 Web 或移动应用中，确保数据获取的类型安全。
开发者工具: 作为开发者工具的一部分，帮助团队成员快速生成和验证查询语句。

项目特点

1. 类型安全

sanity-typed-queries 通过 TypeScript 提供了强大的类型检查功能，确保生成的查询语句在编译时就能发现潜在的错误，减少运行时错误。

2. 零依赖

项目不依赖任何外部库，确保了轻量级和高性能，适合在各种环境中使用。

3. 文档友好

在定义 Schema 时，开发者可以实时查看 Sanity 的文档，确保 Schema 定义符合 Sanity 的规范。

4. 灵活的查询构建

支持多种查询操作，如排序、投影、自定义映射等，满足各种复杂的查询需求。

5. 社区支持

项目欢迎社区贡献，开发者可以根据自己的需求扩展功能，帮助项目不断完善。

快速开始

首先，安装 sanity-typed-queries：

yarn add sanity-typed-queries

# 或者使用 npm

npm install sanity-typed-queries --save

Schema 定义

使用 defineDocument 函数定义你的 Sanity Schema：

import { defineDocument } from 'sanity-typed-queries'

const { document } = defineDocument('author', {
  name: {
    type: 'string',
    validation: Rule => Rule.required(),
  },
  biography: {
    type: 'text',
    rows: 4,
  },
  yearOfBirth: {
    type: 'number',
  },
})

export default document

查询构建

使用 builder 生成类型化的查询语句：

import { builder as authorBuilder } from './cms/schema/author.js'

const [query, type] = authorBuilder.pick('name').first().use()

// *[_type == 'author'][0].name
const queryString = query

// string
type AuthorName = typeof type