## 标量
GraphQL 对象类型具有名称和字段，但在某些时候，这些字段必须解析为一些具体数据。 这就是标量类型的用武之地：它们代表查询的叶子（在此处阅读更多内容）。 GraphQL 包括以下默认类型：`Int`、`Float`、`String`、`Boolean` 和 `ID`。 除了这些内置类型之外，您可能还需要支持自定义原子数据类型（例如，`Date`(日期)）。
#### 代码优先[#](#code-first)代码优先方法附带五个标量，其中三个是现有 GraphQL 类型的简单别名。
* `ID`(`GraphQLID` 的别名) - 表示唯一标识符，通常用于重新获取对象或作为缓存的键
* `Int`(`GraphQLInt` 的别名) - 带符号的 32 位整数
* `Float`(`GraphQLFloat` 的别名) - 有符号双精度浮点值
* `GraphQLISODateTime`\- UTC 的日期时间字符串（默认用于表示`Date`类型）
* `GraphQLTimestamp`\- 一个有符号整数，将日期和时间表示为从 UNIX 纪元开始的毫秒数
默认使用`GraphQLISODateTime`（例如`2019-12-03T09:54:33Z`）来表示`Date`类型。 要改用`GraphQLTimestamp`，请将`buildSchemaOptions`对象的`dateScalarMode`设置为`'timestamp'`，如下所示：
~~~typescript
GraphQLModule.forRoot({
buildSchemaOptions: {
dateScalarMode: 'timestamp',
}
}),
~~~
同样，默认使用 GraphQLFloat 来表示数字类型。 要改用 GraphQLInt，请将 `buildSchemaOptions` 对象的 `numberScalarMode` 设置为“整数”，如下所示：
~~~typescript
GraphQLModule.forRoot({
buildSchemaOptions: {
numberScalarMode: 'integer',
}
}),
~~~
此外，您可以创建自定义标量。 例如，要创建日期标量，只需创建一个新类。
~~~typescript
import { Scalar, CustomScalar } from '@nestjs/graphql';
import { Kind, ValueNode } from 'graphql';
@Scalar('Date', (type) => Date)
export class DateScalar implements CustomScalar<number, Date> {
description = 'Date custom scalar type';
parseValue(value: number): Date {
return new Date(value); // value from the client
}
serialize(value: Date): number {
return value.getTime(); // value sent to the client
}
parseLiteral(ast: ValueNode): Date {
if (ast.kind === Kind.INT) {
return new Date(ast.value);
}
return null;
}
}
~~~
有了这个，注册 DateScalar 作为提供者。
~~~typescript
@Module({
providers: [DateScalar],
})
export class CommonModule {}
~~~
现在我们可以在我们的类中使用 `Date` 类型了。
~~~typescript
@Field()
creationDate: Date;
~~~
#### 架构优先[#](#schema-first)
要定义自定义标量（在[此处](https://www.apollographql.com/docs/graphql-tools/scalars.html)阅读有关标量的更多信息），请创建类型定义和专用解析器。 在这里（如官方文档中所示），我们将使用 `graphql-type-json` 包进行演示。 这个 npm 包定义了一个 JSON GraphQL 标量类型。
从安装包开始：
~~~bash
$ npm i --save graphql-type-json
~~~
安装包后，我们将自定义解析器传递给 forRoot() 方法：
~~~typescript
import GraphQLJSON from 'graphql-type-json';
@Module({
imports: [
GraphQLModule.forRoot({
typePaths: ['./**/*.graphql'],
resolvers: { JSON: GraphQLJSON },
}),
],
})
export class AppModule {}
~~~
现在我们可以在类型定义中使用 JSON 标量：
~~~graphql
scalar JSON
type Foo {
field: JSON
}
~~~
定义标量类型的另一种方法是创建一个简单的类。 假设我们想用 Date 类型增强我们的模式。
~~~typescript
import { Scalar, CustomScalar } from '@nestjs/graphql';
import { Kind, ValueNode } from 'graphql';
@Scalar('Date')
export class DateScalar implements CustomScalar<number, Date> {
description = 'Date custom scalar type';
parseValue(value: number): Date {
return new Date(value); // value from the client
}
serialize(value: Date): number {
return value.getTime(); // value sent to the client
}
parseLiteral(ast: ValueNode): Date {
if (ast.kind === Kind.INT) {
return new Date(ast.value);
}
return null;
}
}
~~~
有了这个，注册 `DateScalar` 作为提供者。
~~~typescript
@Module({
providers: [DateScalar],
})
export class CommonModule {}
~~~
现在我们可以在类型定义中使用 `Date` 标量。
~~~graphql
scalar Date
~~~
默认情况下，为所有标量生成的 TypeScript 定义是 any - 这不是特别安全的。 但是，当您指定如何生成类型时，您可以配置 Nest 如何为您的自定义标量生成类型：
~~~typescript
import { GraphQLDefinitionsFactory } from '@nestjs/graphql';
import { join } from 'path';
const definitionsFactory = new GraphQLDefinitionsFactory()
definitionsFactory.generate({
typePaths: ['./src/**/*.graphql'],
path: join(process.cwd(), 'src/graphql.ts'),
outputAs: 'class',
defaultScalarType: 'unknown',
customScalarTypeMapping: {
DateTime: 'Date',
BigNumber: '_BigNumber',
},
additionalHeader: "import _BigNumber from 'bignumber.js'",
})
~~~
> **提示**：或者，您可以改用类型引用，例如：`DateTime: Date`。 在这种情况下，`GraphQLDefinitionsFactory` 将提取指定类型（`Date.name`）的名称属性来生成 TS 定义。 注意：需要为非内置类型（自定义类型）添加导入语句。
现在，给定以下 GraphQL 自定义标量类型：
~~~graphql
scalar DateTime
scalar BigNumber
scalar Payload
~~~
我们现在将在 `src/graphql.ts` 中看到以下生成的 TypeScript 定义：
~~~typescript
import _BigNumber from 'bignumber.js'
export type DateTime = Date
export type BigNumber = _BigNumber
export type Payload = unknown
~~~
在这里，我们使用了 `customScalarTypeMapping` 属性来提供我们希望为自定义标量声明的类型的映射。 我们还提供了一个附加的`Header` 属性，以便我们可以添加这些类型定义所需的任何导入。 最后，我们添加了一个 `defaultScalarType 'unknown'`，因此任何未在 `customScalarTypeMapping` 中指定的自定义标量都将被别名为 `unknown` 而不是 any（TypeScript 建议从 3.0 开始使用以增加类型安全）。
> 请注意，我们已经从 `bignumber.js` 导入了 `_BigNumber`； 这是为了避免循环类型引用。
- 介绍
- 概述
- 第一步
- 控制器
- 提供者
- 模块
- 中间件
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 自定义装饰器
- 基础知识
- 自定义提供者
- 异步提供者
- 动态模块
- 注入作用域
- 循环依赖
- 模块参考
- 懒加载模块
- 应用上下文
- 生命周期事件
- 跨平台
- 测试
- 技术
- 数据库
- Mongo
- 配置
- 验证
- 缓存
- 序列化
- 版本控制
- 定时任务
- 队列
- 日志
- Cookies
- 事件
- 压缩
- 文件上传
- 流式处理文件
- HTTP模块
- Session(会话)
- MVC
- 性能（Fastify）
- 服务器端事件发送
- 安全
- 认证（Authentication）
- 授权（Authorization）
- 加密和散列
- Helmet
- CORS（跨域请求）
- CSRF保护
- 限速
- GraphQL
- 快速开始
- 解析器（resolvers）
- 变更（Mutations）
- 订阅（Subscriptions）
- 标量（Scalars）
- 指令（directives）
- 接口（Interfaces）
- 联合类型
- 枚举（Enums）
- 字段中间件
- 映射类型
- 插件
- 复杂性
- 扩展
- CLI插件
- 生成SDL
- 其他功能
- 联合服务
- 迁移指南
- Websocket
- 网关
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 适配器
- 微服务
- 概述
- Redis
- MQTT
- NATS
- RabbitMQ
- Kafka
- gRPC
- 自定义传输器
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 独立应用
- Cli
- 概述
- 工作空间
- 库
- 用法
- 脚本
- Openapi
- 介绍
- 类型和参数
- 操作
- 安全
- 映射类型
- 装饰器
- CLI插件
- 其他特性
- 迁移指南
- 秘籍
- CRUD 生成器
- 热重载
- MikroORM
- TypeORM
- Mongoose
- 序列化
- 路由模块
- Swagger
- 健康检查
- CQRS
- 文档
- Prisma
- 静态服务
- Nest Commander
- 问答
- Serverless
- HTTP 适配器
- 全局路由前缀
- 混合应用
- HTTPS 和多服务器
- 请求生命周期
- 常见错误
- 实例
- 迁移指南
- 发现
- 谁在使用Nest？