Skip to content

@codesoul-co/hypha-memory / memory-server-migration-package-schema

模块用法

用于声明并运行时校验契约。Memory server migration package schema 模块公开 2 常量、1 函数。

从包入口导入

ts
import {
  memoryServerMigrationPackageSpecJsonSchema,
  memoryServerMigrationPackageSpecSchema,
  validateMemoryServerMigrationPackageSpec,
} from '@codesoul-co/hypha-memory';

使用要点

  • 1 个函数是该模块的直接操作入口;每个 overload 的必需/可选参数与返回类型均在下方列出。
  • 2 个常量/枚举提供稳定值、Schema、Definition 或默认配置;应复用这些导出,避免在应用中复制内部值。

公共导出

Symbol种类签名说明
memoryServerMigrationPackageSpecJsonSchema常量const memoryServerMigrationPackageSpecJsonSchema: JsonSchemaMemory Server Migration Package Spec 的 JSON Schema。
memoryServerMigrationPackageSpecSchema常量const memoryServerMigrationPackageSpecSchema: ZodType<MemoryServerMigrationPackageSpec, ZodTypeDef, MemoryServerMigrationPackageSpec>Memory Server Migration Package Spec 的运行时 Schema。
validateMemoryServerMigrationPackageSpec函数validateMemoryServerMigrationPackageSpec(input: unknown): MemoryServerMigrationPackageSpecValidate Memory Server Migration Package Spec 函数,提供 1 个公开调用签名;参数与返回类型见下表。

memoryServerMigrationPackageSpecJsonSchema

Memory Server Migration Package Spec 的 JSON Schema。

声明

text
export declare const memoryServerMigrationPackageSpecJsonSchema: JsonSchema;

memoryServerMigrationPackageSpecSchema

Memory Server Migration Package Spec 的运行时 Schema。

声明

text
export declare const memoryServerMigrationPackageSpecSchema: ZodType<MemoryServerMigrationPackageSpec, ZodTypeDef, MemoryServerMigrationPackageSpec>;

validateMemoryServerMigrationPackageSpec

Validate Memory Server Migration Package Spec 函数,提供 1 个公开调用签名;参数与返回类型见下表。

声明

text
export declare function validateMemoryServerMigrationPackageSpec(input: unknown): MemoryServerMigrationPackageSpec;

调用签名

text
validateMemoryServerMigrationPackageSpec(input: unknown): MemoryServerMigrationPackageSpec

参数

参数类型必需说明
inputunknown必需参数;接受的值由类型列定义。

返回值

  • 类型: MemoryServerMigrationPackageSpec
  • 说明: 返回值契约由上述类型定义。