@codesoul-co/hypha-adapters-local / local-artifact-store-values

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/local-artifact-store-values.ts
• Exports: 4

Using this module

Use the Local artifact store values module for persisting and reading data at this boundary. It exports 4 functions.

Import from the package entrypoint

import {
  cloneLocalArtifactMetadata,
  localManifestMetadata,
  normalizeLocalArtifactRange,
  normalizeLocalArtifactStoreError,
} from '@codesoul-co/hypha-adapters-local';

Usage patterns

• The module exposes 4 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
cloneLocalArtifactMetadata	function	cloneLocalArtifactMetadata(value?: Record<string, string>): Record<string, string> | undefined	Clone Local Artifact Metadata function with 1 public call signature; parameters and return types are listed below.
localManifestMetadata	function	localManifestMetadata(manifest: LocalArtifactObjectManifest): ArtifactObjectMetadata	Local Manifest Metadata function with 1 public call signature; parameters and return types are listed below.
normalizeLocalArtifactRange	function	normalizeLocalArtifactRange(range: ArtifactGetRequest["range"], sizeBytes: number): { start: number; endInclusive: number; } | undefined	Normalize Local Artifact Range function with 1 public call signature; parameters and return types are listed below.
normalizeLocalArtifactStoreError	function	normalizeLocalArtifactStoreError(error: unknown, operation: string): ArtifactStoreAdapterError	Normalize Local Artifact Store Error function with 1 public call signature; parameters and return types are listed below.

cloneLocalArtifactMetadata

Clone Local Artifact Metadata function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { cloneLocalArtifactMetadata } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-store-values

Declaration

export declare function cloneLocalArtifactMetadata(value?: Record<string, string>): Record<string, string> | undefined;

Call signature

cloneLocalArtifactMetadata(value?: Record<string, string>): Record<string, string> | undefined

Parameters

Parameter	Type	Required	Description
value	Record<string, string>	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: Record<string, string>
• Description: The return contract is defined by the type shown above.

localManifestMetadata

Local Manifest Metadata function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { localManifestMetadata } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-store-values

Declaration

export declare function localManifestMetadata(manifest: LocalArtifactObjectManifest): ArtifactObjectMetadata;

Call signature

localManifestMetadata(manifest: LocalArtifactObjectManifest): ArtifactObjectMetadata

Parameters

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

Returns

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

normalizeLocalArtifactRange

Normalize Local Artifact Range function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { normalizeLocalArtifactRange } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-store-values

Declaration

export declare function normalizeLocalArtifactRange(range: ArtifactGetRequest['range'], sizeBytes: number): {
    start: number;
    endInclusive: number;
} | undefined;

Call signature

normalizeLocalArtifactRange(range: ArtifactGetRequest["range"], sizeBytes: number): { start: number; endInclusive: number; } | undefined

Parameters

Parameter	Type	Required	Description
range	ArtifactByteRange	Yes	Required parameter; accepted values are defined by the type column.
sizeBytes	number	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: { start: number; endInclusive: number; }
• Description: The return contract is defined by the type shown above.

normalizeLocalArtifactStoreError

Normalize Local Artifact Store Error function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { normalizeLocalArtifactStoreError } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-store-values

Declaration

export declare function normalizeLocalArtifactStoreError(error: unknown, operation: string): ArtifactStoreAdapterError;

Call signature

normalizeLocalArtifactStoreError(error: unknown, operation: string): ArtifactStoreAdapterError

Parameters

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

Returns

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