@codesoul-co/hypha-core / modules/execution-cache/index
- Package index:
@codesoul-co/hypha-core - Source:
packages/core/src/modules/execution-cache/index.ts - Exports: 32
Using this module
Use the Index module for executing runtime behavior at this boundary. It exports 23 constants, 9 functions.
Import from the package entrypoint
import {
executionCacheArtifactReferenceJsonSchema,
executionCacheArtifactReferenceSchema,
executionCacheEntryProjectionExample,
executionCacheEntryProjectionJsonSchema,
executionCacheEntryProjectionSchema,
executionCacheJsonSchemas,
executionCacheRecordJsonSchema,
executionCacheRecordSchema,
} from '@codesoul-co/hypha-core';
// The complete export list is documented below.Usage patterns
- The module exposes 9 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
- The 23 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.
Runtime validation example
import { executionCacheArtifactReferenceSchema } from '@codesoul-co/hypha-core';
declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = executionCacheArtifactReferenceSchema.parse(input);Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.
Public exports
| Symbol | Kind | Signature | Description |
|---|---|---|---|
executionCacheArtifactReferenceJsonSchema | constant | const executionCacheArtifactReferenceJsonSchema: JsonSchema | JSON Schema for Execution Cache Artifact Reference. |
executionCacheArtifactReferenceSchema | constant | const executionCacheArtifactReferenceSchema: z.ZodObject<{ artifactRef: z.ZodString; contentHash: z.ZodString; }, "strict", z.ZodTypeAny, { contentHash: string; artifactRef: string; }, { contentHash: string; artifactRef: string; }> | Runtime schema for Execution Cache Artifact Reference. |
executionCacheEntryProjectionExample | constant | const executionCacheEntryProjectionExample: ExecutionCacheEntryProjection | Valid example value for Execution Cache Entry Projection. |
executionCacheEntryProjectionJsonSchema | constant | const executionCacheEntryProjectionJsonSchema: JsonSchema | JSON Schema for Execution Cache Entry Projection. |
executionCacheEntryProjectionSchema | constant | const executionCacheEntryProjectionSchema: z.ZodEffects<z.ZodObject<{ commandHash: z.ZodString; validityHash: z.ZodString; validity: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; sourceTreeHash: z.ZodString; workspaceSnapshotHash: z.ZodOptional<z.ZodString>; environmentHash: z.ZodString; imageDigest: z.ZodOptional<z.ZodString>; dependencyLockHash: z.ZodOptional<z.ZodString>; networkPolicyHash: z.Zo... | Runtime schema for Execution Cache Entry Projection. |
executionCacheJsonSchemas | constant | const executionCacheJsonSchemas: Record<string, JsonSchema> | Execution Cache JSON Schemas constant exported by the modules/execution-cache/index module. |
executionCacheRecordJsonSchema | constant | const executionCacheRecordJsonSchema: JsonSchema | JSON Schema for Execution Cache Record. |
executionCacheRecordSchema | constant | const executionCacheRecordSchema: z.ZodEffects<z.ZodObject<{ schemaVersion: z.ZodLiteral<"1.0">; keyVersion: z.ZodLiteral<"1">; key: z.ZodString; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodString; }, "strict", z.ZodTypeAny, { workspaceId: string; userId: string; tenantId?: string | undefined; }, { workspaceId: string; userId: string; tenantId?: string | undefi... | Runtime schema for Execution Cache Record. |
executionCacheResultMetadataJsonSchema | constant | const executionCacheResultMetadataJsonSchema: JsonSchema | JSON Schema for Execution Cache Result Metadata. |
executionCacheResultMetadataSchema | constant | const executionCacheResultMetadataSchema: z.ZodEffects<z.ZodObject<{ executionId: z.ZodString; status: z.ZodEnum<["queued", "starting", "running", "cancelling", "cancelled", "completed", "failed", "timed_out", "oom_killed", "resource_exceeded", "quarantined"]>; exitCode: z.ZodNullable<z.ZodNumber>; signal: z.ZodOptional<z.ZodString>; resourceUsage: z.ZodOptional<z.ZodObject<{ cpuTimeMs: z.ZodOptional<z.ZodNumber>;... | Runtime schema for Execution Cache Result Metadata. |
executionCacheScopeJsonSchema | constant | const executionCacheScopeJsonSchema: JsonSchema | JSON Schema for Execution Cache Scope. |
executionCacheScopeSchema | constant | const executionCacheScopeSchema: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodString; }, "strict", z.ZodTypeAny, { workspaceId: string; userId: string; tenantId?: string | undefined; }, { workspaceId: string; userId: string; tenantId?: string | undefined; }> | Runtime schema for Execution Cache Scope. |
executionCacheValidityInputExample | constant | const executionCacheValidityInputExample: ExecutionCacheValidityInput | Valid example value for Execution Cache Validity Input. |
executionCacheValidityInputJsonSchema | constant | const executionCacheValidityInputJsonSchema: JsonSchema | JSON Schema for Execution Cache Validity Input. |
executionCacheValidityInputSchema | constant | const executionCacheValidityInputSchema: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; sourceTreeHash: z.ZodString; workspaceSnapshotHash: z.ZodOptional<z.ZodString>; environmentHash: z.ZodString; imageDigest: z.ZodOptional<z.ZodString>; dependencyLockHash: z.ZodOptional<z.ZodString>; networkPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; commandPolicyRevision: z.ZodOptio... | Runtime schema for Execution Cache Validity Input. |
executionCommandFingerprintInputExample | constant | const executionCommandFingerprintInputExample: ExecutionCommandFingerprintInput | Valid example value for Execution Command Fingerprint Input. |
executionCommandFingerprintInputJsonSchema | constant | const executionCommandFingerprintInputJsonSchema: JsonSchema | JSON Schema for Execution Command Fingerprint Input. |
executionCommandFingerprintInputSchema | constant | const executionCommandFingerprintInputSchema: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; cwd: z.ZodOptional<z.ZodString>; relevantEnvHash: z.ZodString; sourceTreeHash: z.ZodString; environmentHash: z.ZodString; networkPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; idempotencyKey: z.ZodString; }, "strict", z.ZodTypeAny, { idempotencyKey: string; sourceTreeHash: string;... | Runtime schema for Execution Command Fingerprint Input. |
executionEnvironmentFingerprintExample | constant | const executionEnvironmentFingerprintExample: ExecutionEnvironmentFingerprint | Valid example value for Execution Environment Fingerprint. |
executionEnvironmentFingerprintJsonSchema | constant | const executionEnvironmentFingerprintJsonSchema: JsonSchema | JSON Schema for Execution Environment Fingerprint. |
executionEnvironmentFingerprintResolutionJsonSchema | constant | const executionEnvironmentFingerprintResolutionJsonSchema: JsonSchema | JSON Schema for Execution Environment Fingerprint Resolution. |
executionEnvironmentFingerprintResolutionSchema | constant | const executionEnvironmentFingerprintResolutionSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{ status: z.ZodLiteral<"resolved">; fingerprint: z.ZodEffects<z.ZodObject<{ environmentRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string;... | Runtime schema for Execution Environment Fingerprint Resolution. |
executionEnvironmentFingerprintSchema | constant | const executionEnvironmentFingerprintSchema: z.ZodEffects<z.ZodObject<{ environmentRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string; version?: string | undefined; revision?: string | undefined; }>; environmentRevision: z.ZodString; provid... | Runtime schema for Execution Environment Fingerprint. |
assessExecutionCacheReuse | function | assessExecutionCacheReuse(input: ExecutionCacheReuseAssessmentInput): ExecutionCacheReuseAssessment | Assess Execution Cache Reuse function with 1 public call signature; parameters and return types are listed below. |
canonicalizeExecutionFingerprintInput | function | canonicalizeExecutionFingerprintInput(input: ExecutionCommandFingerprintInput | ExecutionCacheValidityInput): string | Canonicalize Execution Fingerprint Input function with 1 public call signature; parameters and return types are listed below. |
validateExecutionCacheEntryProjection | function | validateExecutionCacheEntryProjection(input: unknown): ExecutionCacheEntryProjection | Validate Execution Cache Entry Projection function with 1 public call signature; parameters and return types are listed below. |
validateExecutionCacheRecord | function | validateExecutionCacheRecord(input: unknown, maxEntryBytes?: number): ExecutionCacheRecord | Validate Execution Cache Record function with 1 public call signature; parameters and return types are listed below. |
validateExecutionCacheScope | function | validateExecutionCacheScope(input: unknown): ExecutionCacheScope | Validate Execution Cache Scope function with 1 public call signature; parameters and return types are listed below. |
validateExecutionCacheValidityInput | function | validateExecutionCacheValidityInput(input: unknown): ExecutionCacheValidityInput | Validate Execution Cache Validity Input function with 1 public call signature; parameters and return types are listed below. |
validateExecutionCommandFingerprintInput | function | validateExecutionCommandFingerprintInput(input: unknown): ExecutionCommandFingerprintInput | Validate Execution Command Fingerprint Input function with 1 public call signature; parameters and return types are listed below. |
validateExecutionEnvironmentFingerprint | function | validateExecutionEnvironmentFingerprint(input: unknown): ExecutionEnvironmentFingerprint | Validate Execution Environment Fingerprint function with 1 public call signature; parameters and return types are listed below. |
validateExecutionEnvironmentFingerprintResolution | function | validateExecutionEnvironmentFingerprintResolution(input: unknown): ExecutionEnvironmentFingerprintResolution | Validate Execution Environment Fingerprint Resolution function with 1 public call signature; parameters and return types are listed below. |
executionCacheArtifactReferenceJsonSchema
JSON Schema for Execution Cache Artifact Reference.
- Kind: constant
- Import:
import { executionCacheArtifactReferenceJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheArtifactReferenceJsonSchema: JsonSchema;executionCacheArtifactReferenceSchema
Runtime schema for Execution Cache Artifact Reference.
- Kind: constant
- Import:
import { executionCacheArtifactReferenceSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheArtifactReferenceSchema: z.ZodObject<{ artifactRef: z.ZodString; contentHash: z.ZodString; }, "strict", z.ZodTypeAny, { contentHash: string; artifactRef: string; }, { contentHash: string; artifactRef: string; }>;executionCacheEntryProjectionExample
Valid example value for Execution Cache Entry Projection.
- Kind: constant
- Import:
import { executionCacheEntryProjectionExample } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheEntryProjectionExample: ExecutionCacheEntryProjection;executionCacheEntryProjectionJsonSchema
JSON Schema for Execution Cache Entry Projection.
- Kind: constant
- Import:
import { executionCacheEntryProjectionJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheEntryProjectionJsonSchema: JsonSchema;executionCacheEntryProjectionSchema
Runtime schema for Execution Cache Entry Projection.
- Kind: constant
- Import:
import { executionCacheEntryProjectionSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionCacheEntryProjectionSchema: (typeof import('@codesoul-co/hypha-core'))['executionCacheEntryProjectionSchema'];This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.
executionCacheJsonSchemas
Execution Cache JSON Schemas constant exported by the modules/execution-cache/index module.
- Kind: constant
- Import:
import { executionCacheJsonSchemas } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheJsonSchemas: Record<string, JsonSchema>;executionCacheRecordJsonSchema
JSON Schema for Execution Cache Record.
- Kind: constant
- Import:
import { executionCacheRecordJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheRecordJsonSchema: JsonSchema;executionCacheRecordSchema
Runtime schema for Execution Cache Record.
- Kind: constant
- Import:
import { executionCacheRecordSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionCacheRecordSchema: (typeof import('@codesoul-co/hypha-core'))['executionCacheRecordSchema'];This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.
executionCacheResultMetadataJsonSchema
JSON Schema for Execution Cache Result Metadata.
- Kind: constant
- Import:
import { executionCacheResultMetadataJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheResultMetadataJsonSchema: JsonSchema;executionCacheResultMetadataSchema
Runtime schema for Execution Cache Result Metadata.
- Kind: constant
- Import:
import { executionCacheResultMetadataSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionCacheResultMetadataSchema: (typeof import('@codesoul-co/hypha-core'))['executionCacheResultMetadataSchema'];This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.
executionCacheScopeJsonSchema
JSON Schema for Execution Cache Scope.
- Kind: constant
- Import:
import { executionCacheScopeJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheScopeJsonSchema: JsonSchema;executionCacheScopeSchema
Runtime schema for Execution Cache Scope.
- Kind: constant
- Import:
import { executionCacheScopeSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheScopeSchema: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodString; }, "strict", z.ZodTypeAny, { workspaceId: string; userId: string; tenantId?: string | undefined; }, { workspaceId: string; userId: string; tenantId?: string | undefined; }>;executionCacheValidityInputExample
Valid example value for Execution Cache Validity Input.
- Kind: constant
- Import:
import { executionCacheValidityInputExample } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheValidityInputExample: ExecutionCacheValidityInput;executionCacheValidityInputJsonSchema
JSON Schema for Execution Cache Validity Input.
- Kind: constant
- Import:
import { executionCacheValidityInputJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheValidityInputJsonSchema: JsonSchema;executionCacheValidityInputSchema
Runtime schema for Execution Cache Validity Input.
- Kind: constant
- Import:
import { executionCacheValidityInputSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCacheValidityInputSchema: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; sourceTreeHash: z.ZodString; workspaceSnapshotHash: z.ZodOptional<z.ZodString>; environmentHash: z.ZodString; imageDigest: z.ZodOptional<z.ZodString>; dependencyLockHash: z.ZodOptional<z.ZodString>; networkPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; commandPolicyRevision: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { sourceTreeHash: string; networkPolicyHash: string; executable: string; argsHash: string; environmentHash: string; workspaceSnapshotHash?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; commandPolicyRevision?: string | undefined; }, { sourceTreeHash: string; networkPolicyHash: string; executable: string; argsHash: string; environmentHash: string; workspaceSnapshotHash?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; commandPolicyRevision?: string | undefined; }>;executionCommandFingerprintInputExample
Valid example value for Execution Command Fingerprint Input.
- Kind: constant
- Import:
import { executionCommandFingerprintInputExample } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCommandFingerprintInputExample: ExecutionCommandFingerprintInput;executionCommandFingerprintInputJsonSchema
JSON Schema for Execution Command Fingerprint Input.
- Kind: constant
- Import:
import { executionCommandFingerprintInputJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCommandFingerprintInputJsonSchema: JsonSchema;executionCommandFingerprintInputSchema
Runtime schema for Execution Command Fingerprint Input.
- Kind: constant
- Import:
import { executionCommandFingerprintInputSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionCommandFingerprintInputSchema: z.ZodObject<{ executable: z.ZodString; argsHash: z.ZodString; cwd: z.ZodOptional<z.ZodString>; relevantEnvHash: z.ZodString; sourceTreeHash: z.ZodString; environmentHash: z.ZodString; networkPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; idempotencyKey: z.ZodString; }, "strict", z.ZodTypeAny, { idempotencyKey: string; sourceTreeHash: string; networkPolicyHash: string; executable: string; argsHash: string; environmentHash: string; relevantEnvHash: string; cwd?: string | undefined; secretVersionSetHash?: string | undefined; }, { idempotencyKey: string; sourceTreeHash: string; networkPolicyHash: string; executable: string; argsHash: string; environmentHash: string; relevantEnvHash: string; cwd?: string | undefined; secretVersionSetHash?: string | undefined; }>;executionEnvironmentFingerprintExample
Valid example value for Execution Environment Fingerprint.
- Kind: constant
- Import:
import { executionEnvironmentFingerprintExample } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionEnvironmentFingerprintExample: ExecutionEnvironmentFingerprint;executionEnvironmentFingerprintJsonSchema
JSON Schema for Execution Environment Fingerprint.
- Kind: constant
- Import:
import { executionEnvironmentFingerprintJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionEnvironmentFingerprintJsonSchema: JsonSchema;executionEnvironmentFingerprintResolutionJsonSchema
JSON Schema for Execution Environment Fingerprint Resolution.
- Kind: constant
- Import:
import { executionEnvironmentFingerprintResolutionJsonSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionEnvironmentFingerprintResolutionJsonSchema: JsonSchema;executionEnvironmentFingerprintResolutionSchema
Runtime schema for Execution Environment Fingerprint Resolution.
- Kind: constant
- Import:
import { executionEnvironmentFingerprintResolutionSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionEnvironmentFingerprintResolutionSchema: (typeof import('@codesoul-co/hypha-core'))['executionEnvironmentFingerprintResolutionSchema'];This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.
executionEnvironmentFingerprintSchema
Runtime schema for Execution Environment Fingerprint.
- Kind: constant
- Import:
import { executionEnvironmentFingerprintSchema } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare const executionEnvironmentFingerprintSchema: z.ZodEffects<z.ZodObject<{ environmentRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string; version?: string | undefined; revision?: string | undefined; }>; environmentRevision: z.ZodString; providerId: z.ZodString; imageDigest: z.ZodOptional<z.ZodString>; platform: z.ZodOptional<z.ZodString>; executableVersions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>; dependencyLockHash: z.ZodOptional<z.ZodString>; resourcePolicyHash: z.ZodString; networkPolicyHash: z.ZodString; mountPolicyHash: z.ZodString; secretVersionSetHash: z.ZodOptional<z.ZodString>; fingerprintHash: z.ZodString; }, "strict", z.ZodTypeAny, { environmentRevision: string; providerId: string; networkPolicyHash: string; environmentRef: { id: string; version?: string | undefined; revision?: string | undefined; }; mountPolicyHash: string; resourcePolicyHash: string; fingerprintHash: string; platform?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; executableVersions?: Record<string, string> | undefined; }, { environmentRevision: string; providerId: string; networkPolicyHash: string; environmentRef: { id: string; version?: string | undefined; revision?: string | undefined; }; mountPolicyHash: string; resourcePolicyHash: string; fingerprintHash: string; platform?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; executableVersions?: Record<string, string> | undefined; }>, { environmentRevision: string; providerId: string; networkPolicyHash: string; environmentRef: { id: string; version?: string | undefined; revision?: string | undefined; }; mountPolicyHash: string; resourcePolicyHash: string; fingerprintHash: string; platform?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; executableVersions?: Record<string, string> | undefined; }, { environmentRevision: string; providerId: string; networkPolicyHash: string; environmentRef: { id: string; version?: string | undefined; revision?: string | undefined; }; mountPolicyHash: string; resourcePolicyHash: string; fingerprintHash: string; platform?: string | undefined; imageDigest?: string | undefined; dependencyLockHash?: string | undefined; secretVersionSetHash?: string | undefined; executableVersions?: Record<string, string> | undefined; }>;assessExecutionCacheReuse
Assess Execution Cache Reuse function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { assessExecutionCacheReuse } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function assessExecutionCacheReuse(input: ExecutionCacheReuseAssessmentInput): ExecutionCacheReuseAssessment;Call signature
assessExecutionCacheReuse(input: ExecutionCacheReuseAssessmentInput): ExecutionCacheReuseAssessmentParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | ExecutionCacheReuseAssessmentInput | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
ExecutionCacheReuseAssessment - Description: The return contract is defined by the type shown above.
canonicalizeExecutionFingerprintInput
Canonicalize Execution Fingerprint Input function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { canonicalizeExecutionFingerprintInput } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function canonicalizeExecutionFingerprintInput(input: ExecutionCommandFingerprintInput | ExecutionCacheValidityInput): string;Call signature
canonicalizeExecutionFingerprintInput(input: ExecutionCommandFingerprintInput | ExecutionCacheValidityInput): stringParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | ExecutionCacheValidityInput | ExecutionCommandFingerprintInput | 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.
validateExecutionCacheEntryProjection
Validate Execution Cache Entry Projection function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { validateExecutionCacheEntryProjection } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function validateExecutionCacheEntryProjection(input: unknown): ExecutionCacheEntryProjection;Call signature
validateExecutionCacheEntryProjection(input: unknown): ExecutionCacheEntryProjectionParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | unknown | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
ExecutionCacheEntryProjection - Description: The return contract is defined by the type shown above.
validateExecutionCacheRecord
Validate Execution Cache Record function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { validateExecutionCacheRecord } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function validateExecutionCacheRecord(input: unknown, maxEntryBytes?: number): ExecutionCacheRecord;Call signature
validateExecutionCacheRecord(input: unknown, maxEntryBytes?: number): ExecutionCacheRecordParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | unknown | Yes | Required parameter; accepted values are defined by the type column. |
maxEntryBytes | number | No | Optional parameter; accepted values are defined by the type column. |
Returns
- Type:
ExecutionCacheRecord - Description: The return contract is defined by the type shown above.
validateExecutionCacheScope
Validate Execution Cache Scope function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { validateExecutionCacheScope } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function validateExecutionCacheScope(input: unknown): ExecutionCacheScope;Call signature
validateExecutionCacheScope(input: unknown): ExecutionCacheScopeParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | unknown | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
ExecutionCacheScope - Description: The return contract is defined by the type shown above.
validateExecutionCacheValidityInput
Validate Execution Cache Validity Input function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { validateExecutionCacheValidityInput } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function validateExecutionCacheValidityInput(input: unknown): ExecutionCacheValidityInput;Call signature
validateExecutionCacheValidityInput(input: unknown): ExecutionCacheValidityInputParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | unknown | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
ExecutionCacheValidityInput - Description: The return contract is defined by the type shown above.
validateExecutionCommandFingerprintInput
Validate Execution Command Fingerprint Input function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { validateExecutionCommandFingerprintInput } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function validateExecutionCommandFingerprintInput(input: unknown): ExecutionCommandFingerprintInput;Call signature
validateExecutionCommandFingerprintInput(input: unknown): ExecutionCommandFingerprintInputParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | unknown | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
ExecutionCommandFingerprintInput - Description: The return contract is defined by the type shown above.
validateExecutionEnvironmentFingerprint
Validate Execution Environment Fingerprint function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { validateExecutionEnvironmentFingerprint } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function validateExecutionEnvironmentFingerprint(input: unknown): ExecutionEnvironmentFingerprint;Call signature
validateExecutionEnvironmentFingerprint(input: unknown): ExecutionEnvironmentFingerprintParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | unknown | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
ExecutionEnvironmentFingerprint - Description: The return contract is defined by the type shown above.
validateExecutionEnvironmentFingerprintResolution
Validate Execution Environment Fingerprint Resolution function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { validateExecutionEnvironmentFingerprintResolution } from '@codesoul-co/hypha-core'; - Source module:
modules/execution-cache/index
Declaration
export declare function validateExecutionEnvironmentFingerprintResolution(input: unknown): ExecutionEnvironmentFingerprintResolution;Call signature
validateExecutionEnvironmentFingerprintResolution(input: unknown): ExecutionEnvironmentFingerprintResolutionParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
input | unknown | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
ExecutionEnvironmentFingerprintResolution - Description: The return contract is defined by the type shown above.
