feat(vae): 新增 meta 方法设置一些额外的元数据

fjc0k · Sep 21, 2023 · 9f77a04 · 9f77a04
1 parent ca21a6b
commit 9f77a04
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/src/vae/VaeSchema.ts b/src/vae/VaeSchema.ts
@@ -40,6 +40,12 @@ export type VaeSchemaType =
   | 'boolean'
   | 'array'
 
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface VaeSchemaCustomMetadata {}
+export type VaeSchemaMetadata = keyof VaeSchemaCustomMetadata extends never
+  ? Record<any, any>
+  : VaeSchemaCustomMetadata
+
 export type VaeSchemaOptions<T, S> = {
   type: VaeSchemaType
   label?: string
@@ -51,6 +57,7 @@ export type VaeSchemaOptions<T, S> = {
   stringEmptyable?: boolean
   processors?: Array<VaeSchemaCheckPayload<T> | VaeSchemaTransformPayload<T>>
   runtime?: VaeSchemaRuntimeFn<T, S>
+  metadata?: VaeSchemaMetadata
 }
 
 export type VaeSchemaPath = Array<string | number>
@@ -153,6 +160,11 @@ export abstract class VaeSchema<T extends any = any> {
     return this._options
   }
 
+  meta(metadata: VaeSchemaMetadata) {
+    this._options.metadata = metadata
+    return this
+  }
+
   check(payload: VaeSchemaCheckPayload<T>) {
     const index = payload.tag
       ? findIndex(

diff --git a/src/vae/__snapshots__/vae.test.ts.snap b/src/vae/__snapshots__/vae.test.ts.snap
@@ -374,6 +374,13 @@ Object {
 }
 `;
 
+exports[`vae meta 1`] = `
+Object {
+  "x": 1,
+  "y": "222",
+}
+`;
+
 exports[`vae number 1`] = `
 Object {
   "data": undefined,

diff --git a/src/vae/vae.test.ts b/src/vae/vae.test.ts
@@ -738,4 +738,10 @@ describe('vae', () => {
         ),
     ).toThrowErrorMatchingSnapshot()
   })
+
+  test('meta', () => {
+    expect(
+      v.string().min(3).meta({ x: 1, y: '222' }).options.metadata,
+    ).toMatchSnapshot()
+  })
 })