Skip to content

@codesoul-co/hypha-memory / lifecycle-workers

模块用法

用于使用该功能边界的公共契约与操作。Lifecycle workers 模块公开 8 类、5 接口、2 类型。

从包入口导入

ts
import {
  InMemoryMemoryLifecycleTaskStore,
  LeasedMemoryLifecycleWorker,
  MemoryConsolidationWorker,
  MemoryDecayWorker,
  MemoryDeletionWorker,
  MemoryReindexWorker,
  MemoryRetentionWorker,
  ProviderReconciliationWorker,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryLifecycleTask,
  MemoryLifecycleTaskStore,
  MemoryLifecycleWorkerEvent,
  MemoryLifecycleWorkerOptions,
  MemoryLifecycleWorkerRunResult,
  MemoryLifecycleTaskHandler,
  MemoryLifecycleWorkerType,
} from '@codesoul-co/hypha-memory';

使用要点

  • 7 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用 import type,运行时不应依赖它们。
  • 8 个类提供可实例化的运行时实现;构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol种类签名说明
InMemoryMemoryLifecycleTaskStorenew InMemoryMemoryLifecycleTaskStore(): InMemoryMemoryLifecycleTaskStoreIn Memory Memory Lifecycle Task Store 类,共公开 7 个构造函数或成员;精确签名见本条目的声明与成员表。
LeasedMemoryLifecycleWorkernew LeasedMemoryLifecycleWorker(options: MemoryLifecycleWorkerOptions): LeasedMemoryLifecycleWorkerLeased Memory Lifecycle Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。
MemoryConsolidationWorkernew MemoryConsolidationWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryConsolidationWorkerMemory Consolidation Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。
MemoryDecayWorkernew MemoryDecayWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryDecayWorkerMemory Decay Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。
MemoryDeletionWorkernew MemoryDeletionWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryDeletionWorkerMemory Deletion Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。
MemoryReindexWorkernew MemoryReindexWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryReindexWorkerMemory Reindex Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。
MemoryRetentionWorkernew MemoryRetentionWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryRetentionWorkerMemory Retention Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。
ProviderReconciliationWorkernew ProviderReconciliationWorker(options: Omit<MemoryLifecycleWorkerOptions, "type">): ProviderReconciliationWorkerProvider Reconciliation Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。
MemoryLifecycleTask接口interface MemoryLifecycleTaskMemory Lifecycle Task 接口,共包含 15 个公开字段或方法。
MemoryLifecycleTaskStore接口interface MemoryLifecycleTaskStoreMemory Lifecycle Task Store 接口,共包含 6 个公开字段或方法。
MemoryLifecycleWorkerEvent接口interface MemoryLifecycleWorkerEventMemory Lifecycle Worker Event 接口,共包含 5 个公开字段或方法。
MemoryLifecycleWorkerOptions接口interface MemoryLifecycleWorkerOptionsMemory Lifecycle Worker Options 接口,共包含 12 个公开字段或方法。
MemoryLifecycleWorkerRunResult接口interface MemoryLifecycleWorkerRunResultMemory Lifecycle Worker Run Result 接口,共包含 4 个公开字段或方法。
MemoryLifecycleTaskHandler类型type MemoryLifecycleTaskHandler = (task: MemoryLifecycleTask, signal: AbortSignal) => Promise<void>Memory Lifecycle Task Handler 公共类型别名;完整类型表达式见声明。
MemoryLifecycleWorkerType类型type MemoryLifecycleWorkerType = 'retention' | 'decay' | 'consolidation' | 'deletion' | 'reindex' | 'provider_reconciliation'Memory Lifecycle Worker Type 公共类型别名;完整类型表达式见声明。

InMemoryMemoryLifecycleTaskStore

In Memory Memory Lifecycle Task Store 类,共公开 7 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { InMemoryMemoryLifecycleTaskStore } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export declare class InMemoryMemoryLifecycleTaskStore implements MemoryLifecycleTaskStore {
    enqueue(task: MemoryLifecycleTask): Promise<void>;
    lease(type: MemoryLifecycleWorkerType, ownerId: string, now: string, leaseUntil: string, limit: number): Promise<MemoryLifecycleTask[]>;
    renew(taskId: string, ownerId: string, leaseToken: string, now: string, leaseUntil: string): Promise<boolean>;
    complete(taskId: string, ownerId: string, leaseToken: string, now: string): Promise<boolean>;
    fail(taskId: string, ownerId: string, leaseToken: string, now: string, error: NormalizedMemoryError, retryAt: string, deadLetter: boolean): Promise<boolean>;
    list(type?: MemoryLifecycleWorkerType): Promise<MemoryLifecycleTask[]>;
}

公开成员

成员种类签名说明
complete方法complete(taskId: string, ownerId: string, leaseToken: string, now: string): Promise<boolean>公开方法;参数与返回类型以签名列为准。
constructor构造函数(): InMemoryMemoryLifecycleTaskStore创建该类的实例。
enqueue方法enqueue(task: MemoryLifecycleTask): Promise<void>公开方法;参数与返回类型以签名列为准。
fail方法fail(taskId: string, ownerId: string, leaseToken: string, now: string, error: NormalizedMemoryError, retryAt: string, deadLetter: boolean): Promise<boolean>公开方法;参数与返回类型以签名列为准。
lease方法lease(type: MemoryLifecycleWorkerType, ownerId: string, now: string, leaseUntil: string, limit: number): Promise<MemoryLifecycleTask[]>公开方法;参数与返回类型以签名列为准。
list方法list(type?: MemoryLifecycleWorkerType): Promise<MemoryLifecycleTask[]>公开方法;参数与返回类型以签名列为准。
renew方法renew(taskId: string, ownerId: string, leaseToken: string, now: string, leaseUntil: string): Promise<boolean>公开方法;参数与返回类型以签名列为准。

LeasedMemoryLifecycleWorker

Leased Memory Lifecycle Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { LeasedMemoryLifecycleWorker } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export declare class LeasedMemoryLifecycleWorker {
    constructor(options: MemoryLifecycleWorkerOptions);
    runOnce(): Promise<MemoryLifecycleWorkerRunResult>;
    start(): void;
    stop(): void;
    drain(): Promise<void>;
    stopAndDrain(): Promise<void>;
}

公开成员

成员种类签名说明
constructor构造函数(options: MemoryLifecycleWorkerOptions): LeasedMemoryLifecycleWorker创建该类的实例。
drain方法drain(): Promise<void>公开方法;参数与返回类型以签名列为准。
runOnce方法runOnce(): Promise<MemoryLifecycleWorkerRunResult>公开方法;参数与返回类型以签名列为准。
start方法start(): void公开方法;参数与返回类型以签名列为准。
stop方法stop(): void公开方法;参数与返回类型以签名列为准。
stopAndDrain方法stopAndDrain(): Promise<void>公开方法;参数与返回类型以签名列为准。

MemoryConsolidationWorker

Memory Consolidation Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { MemoryConsolidationWorker } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export declare class MemoryConsolidationWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

公开成员

成员种类签名说明
constructor构造函数(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryConsolidationWorker创建该类的实例。
drain方法drain(): Promise<void>公开方法;参数与返回类型以签名列为准。
runOnce方法runOnce(): Promise<MemoryLifecycleWorkerRunResult>公开方法;参数与返回类型以签名列为准。
start方法start(): void公开方法;参数与返回类型以签名列为准。
stop方法stop(): void公开方法;参数与返回类型以签名列为准。
stopAndDrain方法stopAndDrain(): Promise<void>公开方法;参数与返回类型以签名列为准。

MemoryDecayWorker

Memory Decay Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { MemoryDecayWorker } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export declare class MemoryDecayWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

公开成员

成员种类签名说明
constructor构造函数(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryDecayWorker创建该类的实例。
drain方法drain(): Promise<void>公开方法;参数与返回类型以签名列为准。
runOnce方法runOnce(): Promise<MemoryLifecycleWorkerRunResult>公开方法;参数与返回类型以签名列为准。
start方法start(): void公开方法;参数与返回类型以签名列为准。
stop方法stop(): void公开方法;参数与返回类型以签名列为准。
stopAndDrain方法stopAndDrain(): Promise<void>公开方法;参数与返回类型以签名列为准。

MemoryDeletionWorker

Memory Deletion Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { MemoryDeletionWorker } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export declare class MemoryDeletionWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

公开成员

成员种类签名说明
constructor构造函数(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryDeletionWorker创建该类的实例。
drain方法drain(): Promise<void>公开方法;参数与返回类型以签名列为准。
runOnce方法runOnce(): Promise<MemoryLifecycleWorkerRunResult>公开方法;参数与返回类型以签名列为准。
start方法start(): void公开方法;参数与返回类型以签名列为准。
stop方法stop(): void公开方法;参数与返回类型以签名列为准。
stopAndDrain方法stopAndDrain(): Promise<void>公开方法;参数与返回类型以签名列为准。

MemoryReindexWorker

Memory Reindex Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { MemoryReindexWorker } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export declare class MemoryReindexWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

公开成员

成员种类签名说明
constructor构造函数(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryReindexWorker创建该类的实例。
drain方法drain(): Promise<void>公开方法;参数与返回类型以签名列为准。
runOnce方法runOnce(): Promise<MemoryLifecycleWorkerRunResult>公开方法;参数与返回类型以签名列为准。
start方法start(): void公开方法;参数与返回类型以签名列为准。
stop方法stop(): void公开方法;参数与返回类型以签名列为准。
stopAndDrain方法stopAndDrain(): Promise<void>公开方法;参数与返回类型以签名列为准。

MemoryRetentionWorker

Memory Retention Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { MemoryRetentionWorker } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export declare class MemoryRetentionWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

公开成员

成员种类签名说明
constructor构造函数(options: Omit<MemoryLifecycleWorkerOptions, "type">): MemoryRetentionWorker创建该类的实例。
drain方法drain(): Promise<void>公开方法;参数与返回类型以签名列为准。
runOnce方法runOnce(): Promise<MemoryLifecycleWorkerRunResult>公开方法;参数与返回类型以签名列为准。
start方法start(): void公开方法;参数与返回类型以签名列为准。
stop方法stop(): void公开方法;参数与返回类型以签名列为准。
stopAndDrain方法stopAndDrain(): Promise<void>公开方法;参数与返回类型以签名列为准。

ProviderReconciliationWorker

Provider Reconciliation Worker 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { ProviderReconciliationWorker } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export declare class ProviderReconciliationWorker extends LeasedMemoryLifecycleWorker {
    constructor(options: Omit<MemoryLifecycleWorkerOptions, 'type'>);
}

公开成员

成员种类签名说明
constructor构造函数(options: Omit<MemoryLifecycleWorkerOptions, "type">): ProviderReconciliationWorker创建该类的实例。
drain方法drain(): Promise<void>公开方法;参数与返回类型以签名列为准。
runOnce方法runOnce(): Promise<MemoryLifecycleWorkerRunResult>公开方法;参数与返回类型以签名列为准。
start方法start(): void公开方法;参数与返回类型以签名列为准。
stop方法stop(): void公开方法;参数与返回类型以签名列为准。
stopAndDrain方法stopAndDrain(): Promise<void>公开方法;参数与返回类型以签名列为准。

MemoryLifecycleTask

Memory Lifecycle Task 接口,共包含 15 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryLifecycleTask } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export interface MemoryLifecycleTask<TPayload = unknown> {
    id: string;
    operationId: string;
    type: MemoryLifecycleWorkerType;
    scopeHash: string;
    payload: TPayload;
    state: 'pending' | 'processing' | 'completed' | 'failed' | 'dead_letter';
    attempts: number;
    availableAt: string;
    leaseOwner?: string;
    leaseToken?: string;
    leaseExpiresAt?: string;
    fencingToken?: number;
    lastError?: NormalizedMemoryError;
    createdAt: string;
    updatedAt: string;
}

契约成员

成员种类签名说明
attempts属性attempts: number公开属性;类型、只读和可选状态以签名列为准。
availableAt属性availableAt: string公开属性;类型、只读和可选状态以签名列为准。
createdAt属性createdAt: string公开属性;类型、只读和可选状态以签名列为准。
fencingToken属性fencingToken?: number公开属性;类型、只读和可选状态以签名列为准。
id属性id: string公开属性;类型、只读和可选状态以签名列为准。
lastError属性lastError?: NormalizedMemoryError公开属性;类型、只读和可选状态以签名列为准。
leaseExpiresAt属性leaseExpiresAt?: string公开属性;类型、只读和可选状态以签名列为准。
leaseOwner属性leaseOwner?: string公开属性;类型、只读和可选状态以签名列为准。
leaseToken属性leaseToken?: string公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
payload属性payload: TPayload公开属性;类型、只读和可选状态以签名列为准。
scopeHash属性scopeHash: string公开属性;类型、只读和可选状态以签名列为准。
state属性state: "completed" | "failed" | "processing" | "pending" | "dead_letter"公开属性;类型、只读和可选状态以签名列为准。
type属性type: MemoryLifecycleWorkerType公开属性;类型、只读和可选状态以签名列为准。
updatedAt属性updatedAt: string公开属性;类型、只读和可选状态以签名列为准。

MemoryLifecycleTaskStore

Memory Lifecycle Task Store 接口,共包含 6 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryLifecycleTaskStore } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export interface MemoryLifecycleTaskStore {
    enqueue(task: MemoryLifecycleTask): Promise<void>;
    lease(type: MemoryLifecycleWorkerType, ownerId: string, now: string, leaseUntil: string, limit: number): Promise<MemoryLifecycleTask[]>;
    renew(taskId: string, ownerId: string, leaseToken: string, now: string, leaseUntil: string): Promise<boolean>;
    complete(taskId: string, ownerId: string, leaseToken: string, now: string): Promise<boolean>;
    fail(taskId: string, ownerId: string, leaseToken: string, now: string, error: NormalizedMemoryError, retryAt: string, deadLetter: boolean): Promise<boolean>;
    list(type?: MemoryLifecycleWorkerType): Promise<MemoryLifecycleTask[]>;
}

契约成员

成员种类签名说明
complete方法complete(taskId: string, ownerId: string, leaseToken: string, now: string): Promise<boolean>公开方法;参数与返回类型以签名列为准。
enqueue方法enqueue(task: MemoryLifecycleTask): Promise<void>公开方法;参数与返回类型以签名列为准。
fail方法fail(taskId: string, ownerId: string, leaseToken: string, now: string, error: NormalizedMemoryError, retryAt: string, deadLetter: boolean): Promise<boolean>公开方法;参数与返回类型以签名列为准。
lease方法lease(type: MemoryLifecycleWorkerType, ownerId: string, now: string, leaseUntil: string, limit: number): Promise<MemoryLifecycleTask[]>公开方法;参数与返回类型以签名列为准。
list方法list(type?: MemoryLifecycleWorkerType): Promise<MemoryLifecycleTask[]>公开方法;参数与返回类型以签名列为准。
renew方法renew(taskId: string, ownerId: string, leaseToken: string, now: string, leaseUntil: string): Promise<boolean>公开方法;参数与返回类型以签名列为准。

MemoryLifecycleWorkerEvent

Memory Lifecycle Worker Event 接口,共包含 5 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryLifecycleWorkerEvent } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export interface MemoryLifecycleWorkerEvent {
    type: 'memory.worker.started' | 'memory.worker.stopped' | 'memory.worker.failed' | 'memory.worker.dead_lettered';
    workerType: MemoryLifecycleWorkerType;
    taskId?: string;
    operationId?: string;
    error?: NormalizedMemoryError;
}

契约成员

成员种类签名说明
error属性error?: NormalizedMemoryError公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId?: string公开属性;类型、只读和可选状态以签名列为准。
taskId属性taskId?: string公开属性;类型、只读和可选状态以签名列为准。
type属性type: "memory.worker.started" | "memory.worker.stopped" | "memory.worker.failed" | "memory.worker.dead_lettered"公开属性;类型、只读和可选状态以签名列为准。
workerType属性workerType: MemoryLifecycleWorkerType公开属性;类型、只读和可选状态以签名列为准。

MemoryLifecycleWorkerOptions

Memory Lifecycle Worker Options 接口,共包含 12 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryLifecycleWorkerOptions } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export interface MemoryLifecycleWorkerOptions {
    type: MemoryLifecycleWorkerType;
    ownerId: string;
    store: MemoryLifecycleTaskStore;
    handler: MemoryLifecycleTaskHandler;
    batchSize?: number;
    leaseMs?: number;
    renewalMs?: number;
    retryDelayMs?: number;
    maxAttempts?: number;
    pollIntervalMs?: number;
    now?: () => Date;
    onEvent?: (event: MemoryLifecycleWorkerEvent) => void | Promise<void>;
}

契约成员

成员种类签名说明
batchSize属性batchSize?: number公开属性;类型、只读和可选状态以签名列为准。
handler方法handler(task: MemoryLifecycleTask, signal: AbortSignal): Promise<void>公开方法;参数与返回类型以签名列为准。
leaseMs属性leaseMs?: number公开属性;类型、只读和可选状态以签名列为准。
maxAttempts属性maxAttempts?: number公开属性;类型、只读和可选状态以签名列为准。
now方法now?(): Date公开方法;参数与返回类型以签名列为准。
onEvent方法onEvent?(event: MemoryLifecycleWorkerEvent): void | Promise<void>公开方法;参数与返回类型以签名列为准。
ownerId属性ownerId: string公开属性;类型、只读和可选状态以签名列为准。
pollIntervalMs属性pollIntervalMs?: number公开属性;类型、只读和可选状态以签名列为准。
renewalMs属性renewalMs?: number公开属性;类型、只读和可选状态以签名列为准。
retryDelayMs属性retryDelayMs?: number公开属性;类型、只读和可选状态以签名列为准。
store属性store: MemoryLifecycleTaskStore公开属性;类型、只读和可选状态以签名列为准。
type属性type: MemoryLifecycleWorkerType公开属性;类型、只读和可选状态以签名列为准。

MemoryLifecycleWorkerRunResult

Memory Lifecycle Worker Run Result 接口,共包含 4 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryLifecycleWorkerRunResult } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export interface MemoryLifecycleWorkerRunResult {
    leased: number;
    completed: number;
    failed: number;
    deadLettered: number;
}

契约成员

成员种类签名说明
completed属性completed: number公开属性;类型、只读和可选状态以签名列为准。
deadLettered属性deadLettered: number公开属性;类型、只读和可选状态以签名列为准。
failed属性failed: number公开属性;类型、只读和可选状态以签名列为准。
leased属性leased: number公开属性;类型、只读和可选状态以签名列为准。

MemoryLifecycleTaskHandler

Memory Lifecycle Task Handler 公共类型别名;完整类型表达式见声明。

  • 种类: 类型
  • 导入: import type { MemoryLifecycleTaskHandler } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export type MemoryLifecycleTaskHandler = (task: MemoryLifecycleTask, signal: AbortSignal) => Promise<void>;

MemoryLifecycleWorkerType

Memory Lifecycle Worker Type 公共类型别名;完整类型表达式见声明。

  • 种类: 类型
  • 导入: import type { MemoryLifecycleWorkerType } from '@codesoul-co/hypha-memory';
  • 源码模块: lifecycle-workers

声明

text
export type MemoryLifecycleWorkerType = 'retention' | 'decay' | 'consolidation' | 'deletion' | 'reindex' | 'provider_reconciliation';