@codesoul-co/hypha-memory / external-memory-identity
- Package index:
@codesoul-co/hypha-memory - Source:
packages/memory/src/external-memory-identity.ts - Exports: 1
Using this module
Use the External memory identity module for using the public contracts and operations for this capability boundary. It exports 1 function.
Import from the package entrypoint
ts
import {
createExternalMemoryId,
} 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.
Public exports
| Symbol | Kind | Signature | Description |
|---|---|---|---|
createExternalMemoryId | function | createExternalMemoryId(providerId: string, externalId: string): string | Builds the stable Hypha-owned identifier for an external provider record. The provider identifier is retained separately as providerExternalId. |
createExternalMemoryId
Builds the stable Hypha-owned identifier for an external provider record. The provider identifier is retained separately as providerExternalId.
- Kind: function
- Import:
import { createExternalMemoryId } from '@codesoul-co/hypha-memory'; - Source module:
external-memory-identity
Declaration
text
export declare function createExternalMemoryId(providerId: string, externalId: string): string;Call signature
text
createExternalMemoryId(providerId: string, externalId: string): stringBuilds the stable Hypha-owned identifier for an external provider record. The provider identifier is retained separately as providerExternalId.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
providerId | string | Yes | Required parameter; accepted values are defined by the type column. |
externalId | string | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
string - Description: The return contract is defined by the type shown above.
