@codesoul-co/hypha-memory / hindsight-local-factory
- Package index:
@codesoul-co/hypha-memory - Source:
packages/memory/src/hindsight-local-factory.ts - Exports: 5
Using this module
Use the Hindsight local factory module for using the public contracts and operations for this capability boundary. It exports 1 constant, 2 functions, 2 interfaces.
Import from the package entrypoint
ts
import {
HINDSIGHT_LOCAL_FACTORY_ID,
createHindsightLocalMemoryProviderFactory,
registerHindsightLocalMemoryProvider,
} from '@codesoul-co/hypha-memory';
import type {
HindsightLocalConnection,
HindsightLocalFactoryOptions,
} from '@codesoul-co/hypha-memory';Usage patterns
- Use the 2 type/interface exports as static contracts in application code, adapters, or tests. Import them with
import type; they do not exist at runtime. - The module exposes 2 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
- The 1 constant/enum export provides stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.
Public exports
| Symbol | Kind | Signature | Description |
|---|---|---|---|
HINDSIGHT_LOCAL_FACTORY_ID | constant | const HINDSIGHT_LOCAL_FACTORY_ID: "memory.factory.memorybank.hindsight-local" | HINDSIGHT LOCAL FACTORY ID constant exported by the hindsight-local-factory module. |
createHindsightLocalMemoryProviderFactory | function | createHindsightLocalMemoryProviderFactory(options?: HindsightLocalFactoryOptions): MemoryManagementProviderFactory | Create Hindsight Local Memory Provider Factory function with 1 public call signature; parameters and return types are listed below. |
registerHindsightLocalMemoryProvider | function | registerHindsightLocalMemoryProvider(registry: MemoryManagementProviderRegistry, options?: HindsightLocalFactoryOptions): MemoryManagementProviderRegistry | Register Hindsight Local Memory Provider function with 1 public call signature; parameters and return types are listed below. |
HindsightLocalConnection | interface | interface HindsightLocalConnection | Hindsight Local Connection interface with 3 public fields or methods. |
HindsightLocalFactoryOptions | interface | interface HindsightLocalFactoryOptions | Hindsight Local Factory Options interface with 2 public fields or methods. |
HINDSIGHT_LOCAL_FACTORY_ID
HINDSIGHT LOCAL FACTORY ID constant exported by the hindsight-local-factory module.
- Kind: constant
- Import:
import { HINDSIGHT_LOCAL_FACTORY_ID } from '@codesoul-co/hypha-memory'; - Source module:
hindsight-local-factory
Declaration
text
export declare const HINDSIGHT_LOCAL_FACTORY_ID: "memory.factory.memorybank.hindsight-local";createHindsightLocalMemoryProviderFactory
Create Hindsight Local Memory Provider Factory function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { createHindsightLocalMemoryProviderFactory } from '@codesoul-co/hypha-memory'; - Source module:
hindsight-local-factory
Declaration
text
export declare function createHindsightLocalMemoryProviderFactory(options?: HindsightLocalFactoryOptions): MemoryManagementProviderFactory;Call signature
text
createHindsightLocalMemoryProviderFactory(options?: HindsightLocalFactoryOptions): MemoryManagementProviderFactoryParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
options | HindsightLocalFactoryOptions | No | Optional parameter; accepted values are defined by the type column. |
Returns
- Type:
MemoryManagementProviderFactory - Description: The return contract is defined by the type shown above.
registerHindsightLocalMemoryProvider
Register Hindsight Local Memory Provider function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { registerHindsightLocalMemoryProvider } from '@codesoul-co/hypha-memory'; - Source module:
hindsight-local-factory
Declaration
text
export declare function registerHindsightLocalMemoryProvider(registry: MemoryManagementProviderRegistry, options?: HindsightLocalFactoryOptions): MemoryManagementProviderRegistry;Call signature
text
registerHindsightLocalMemoryProvider(registry: MemoryManagementProviderRegistry, options?: HindsightLocalFactoryOptions): MemoryManagementProviderRegistryParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
registry | MemoryManagementProviderRegistry | Yes | Required parameter; accepted values are defined by the type column. |
options | HindsightLocalFactoryOptions | No | Optional parameter; accepted values are defined by the type column. |
Returns
- Type:
MemoryManagementProviderRegistry - Description: The return contract is defined by the type shown above.
HindsightLocalConnection
Hindsight Local Connection interface with 3 public fields or methods.
- Kind: interface
- Import:
import type { HindsightLocalConnection } from '@codesoul-co/hypha-memory'; - Source module:
hindsight-local-factory
Declaration
text
export interface HindsightLocalConnection {
baseUrl: string;
bearerToken?: string;
fetch?: Mem0HttpFetch;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
baseUrl | property | baseUrl: string | Public property; its type, readonly modifier and optionality are shown in the signature. |
bearerToken | property | bearerToken?: string | Public property; its type, readonly modifier and optionality are shown in the signature. |
fetch | method | fetch?(url: string, init?: { method?: string; headers?: Record<string, string>; body?: string; signal?: AbortSignal; }): Promise<import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/mem0-rest-client").Mem0HttpResponse> | Public method; parameters and return type are shown in the signature. |
HindsightLocalFactoryOptions
Hindsight Local Factory Options interface with 2 public fields or methods.
- Kind: interface
- Import:
import type { HindsightLocalFactoryOptions } from '@codesoul-co/hypha-memory'; - Source module:
hindsight-local-factory
Declaration
text
export interface HindsightLocalFactoryOptions {
fetch?: Mem0HttpFetch;
operationDeadlineMs?: number;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
fetch | method | fetch?(url: string, init?: { method?: string; headers?: Record<string, string>; body?: string; signal?: AbortSignal; }): Promise<import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/mem0-rest-client").Mem0HttpResponse> | Public method; parameters and return type are shown in the signature. |
operationDeadlineMs | property | operationDeadlineMs?: number | Public property; its type, readonly modifier and optionality are shown in the signature. |
