Skip to content

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

Using this module

Use the Memory server migration package schema module for declaring and runtime-validating contracts. It exports 2 constants, 1 function.

Import from the package entrypoint

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

Usage patterns

  • The module exposes 1 function as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
  • The 2 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

SymbolKindSignatureDescription
memoryServerMigrationPackageSpecJsonSchemaconstantconst memoryServerMigrationPackageSpecJsonSchema: JsonSchemaJSON Schema for Memory Server Migration Package Spec.
memoryServerMigrationPackageSpecSchemaconstantconst memoryServerMigrationPackageSpecSchema: ZodType<MemoryServerMigrationPackageSpec, ZodTypeDef, MemoryServerMigrationPackageSpec>Runtime schema for Memory Server Migration Package Spec.
validateMemoryServerMigrationPackageSpecfunctionvalidateMemoryServerMigrationPackageSpec(input: unknown): MemoryServerMigrationPackageSpecValidate Memory Server Migration Package Spec function with 1 public call signature; parameters and return types are listed below.

memoryServerMigrationPackageSpecJsonSchema

JSON Schema for Memory Server Migration Package Spec.

Declaration

text
export declare const memoryServerMigrationPackageSpecJsonSchema: JsonSchema;

memoryServerMigrationPackageSpecSchema

Runtime schema for Memory Server Migration Package Spec.

Declaration

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

validateMemoryServerMigrationPackageSpec

Validate Memory Server Migration Package Spec function with 1 public call signature; parameters and return types are listed below.

Declaration

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

Call signature

text
validateMemoryServerMigrationPackageSpec(input: unknown): MemoryServerMigrationPackageSpec

Parameters

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns

  • Type: MemoryServerMigrationPackageSpec
  • Description: The return contract is defined by the type shown above.