@codesoul-co/hypha-memory / external-provider-url

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/external-provider-url.ts
• Exports: 3

Using this module

Use the External provider url module for binding external or local providers to Hypha ports. It exports 2 functions, 1 interface.

Import from the package entrypoint

import {
  isLoopbackHostname,
  normalizeExternalProviderBaseUrl,
} from '@codesoul-co/hypha-memory';

import type {
  ExternalProviderBaseUrlOptions,
} from '@codesoul-co/hypha-memory';

Usage patterns

• Use the 1 type/interface export 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.

Public exports

Symbol	Kind	Signature	Description
isLoopbackHostname	function	isLoopbackHostname(hostname: string): boolean	Is Loopback Hostname function with 1 public call signature; parameters and return types are listed below.
normalizeExternalProviderBaseUrl	function	normalizeExternalProviderBaseUrl(value: string, options: ExternalProviderBaseUrlOptions): string	Normalizes an external Memory Provider base URL and fails closed before a credential can be attached to an unsafe or ambiguous destination.
ExternalProviderBaseUrlOptions	interface	interface ExternalProviderBaseUrlOptions	External Provider Base URL Options interface with 3 public fields or methods.

isLoopbackHostname

Is Loopback Hostname function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { isLoopbackHostname } from '@codesoul-co/hypha-memory';
• Source module: external-provider-url

Declaration

export declare function isLoopbackHostname(hostname: string): boolean;

Call signature

isLoopbackHostname(hostname: string): boolean

Parameters

Parameter	Type	Required	Description
hostname	string	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

normalizeExternalProviderBaseUrl

Normalizes an external Memory Provider base URL and fails closed before a credential can be attached to an unsafe or ambiguous destination.

• Kind: function
• Import: import { normalizeExternalProviderBaseUrl } from '@codesoul-co/hypha-memory';
• Source module: external-provider-url

Declaration

export declare function normalizeExternalProviderBaseUrl(value: string, options: ExternalProviderBaseUrlOptions): string;

Call signature

normalizeExternalProviderBaseUrl(value: string, options: ExternalProviderBaseUrlOptions): string

Normalizes an external Memory Provider base URL and fails closed before a credential can be attached to an unsafe or ambiguous destination.

Parameters

Parameter	Type	Required	Description
value	string	Yes	Required parameter; accepted values are defined by the type column.
options	ExternalProviderBaseUrlOptions	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.

ExternalProviderBaseUrlOptions

External Provider Base URL Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ExternalProviderBaseUrlOptions } from '@codesoul-co/hypha-memory';
• Source module: external-provider-url

Declaration

export interface ExternalProviderBaseUrlOptions {
    providerName: string;
    allowLoopbackHttp?: boolean;
    allowInsecureForTests?: boolean;
}

Contract members

Member	Kind	Signature	Description
allowInsecureForTests	property	allowInsecureForTests?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
allowLoopbackHttp	property	allowLoopbackHttp?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
providerName	property	providerName: string	Public property; its type, readonly modifier and optionality are shown in the signature.